<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit - Firmware API: osc.c Source File</title>
<link href="mt_doxygen.css" rel="stylesheet" type="text/css" />
<link href="../resources/mt_doxytabs.css" rel="stylesheet" type="text/css" />
<style type="text/css">
<!--
.header {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 12pt;
	color: #222222;
}
-->
</style>
</head>

<body>
<table width="800" border="0">
    <tr>
      <td colspan="3">
        <form method="get" action="http://www.google.com/search">
          <div align="right">
            <input type="text"   name="q" size="25"
              maxlength="255" value="" />
            <input type="submit" value="Search" />
            <input type="hidden" name="sitesearch" value="makingthings.com/ref/firmware/html" />
          </div>
        </form>
       </td>
    </tr>
    <tr>
      <td><div align="center"><a href="http://www.makingthings.com">
				<img src="../resources/logo_brown_medium.png" alt="MakingThings"
									width="200" height="78" border="0" align="middle" longdesc="http://www.makingthings.com" /></a></div></td>
				<td><div align="center" class="header">
      		Make Controller Kit <br />
          Firmware API
      </div></td>
      <td><div align="center"><a href="http://www.makezine.com">
					<img src="../resources/make_logo.png" alt="MAKE Zine" 
										width="164" height="73" border="0" align="middle" longdesc="http://www.makezine.com" /></a></div></td>
    </tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.5.4 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
  var num=this.id.replace(/[^[0-9]/g,'');
  var button=this.firstChild;
  var sectionDiv=document.getElementById('dynsection'+num);
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
    sectionDiv.style.display='block';
    button.src='open.gif';
  }else{
    sectionDiv.style.display='none';
    button.src='closed.gif';
  }
}
function initDynSections(){
  var divs=document.getElementsByTagName('div');
  var sectionCounter=1;
  for(var i=0;i<divs.length-1;i++){
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
      var header=divs[i];
      var section=divs[i+1];
      var button=header.firstChild;
      if (button!='IMG'){
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
        button=document.createElement('img');
        divs[i].insertBefore(button,divs[i].firstChild);
      }
      header.style.cursor='pointer';
      header.onclick=changeDisplayState;
      header.id='dynheader'+sectionCounter;
      button.src='closed.gif';
      section.id='dynsection'+sectionCounter;
      section.style.display='none';
      section.style.marginLeft='14px';
      sectionCounter++;
    }
  }
}
window.onload = initDynSections;
-->
</script>
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>osc.c</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*********************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Copyright 2006 MakingThings</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> Licensed under the Apache License, </span>
<a name="l00006"></a>00006 <span class="comment"> Version 2.0 (the "License"); you may not use this file except in compliance </span>
<a name="l00007"></a>00007 <span class="comment"> with the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> http://www.apache.org/licenses/LICENSE-2.0 </span>
<a name="l00010"></a>00010 <span class="comment"> </span>
<a name="l00011"></a>00011 <span class="comment"> Unless required by applicable law or agreed to in writing, software distributed</span>
<a name="l00012"></a>00012 <span class="comment"> under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR</span>
<a name="l00013"></a>00013 <span class="comment"> CONDITIONS OF ANY KIND, either express or implied. See the License for</span>
<a name="l00014"></a>00014 <span class="comment"> the specific language governing permissions and limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">*********************************************************************************/</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment">/** @defgroup OSC</span>
<a name="l00019"></a>00019 <span class="comment">  Communicate with the Make Controller Kit via OSC.</span>
<a name="l00020"></a>00020 <span class="comment">  </span>
<a name="l00021"></a>00021 <span class="comment">  \section osc OSC</span>
<a name="l00022"></a>00022 <span class="comment">  "Open Sound Control (OSC) is a protocol for communication among computers, sound synthesizers, </span>
<a name="l00023"></a>00023 <span class="comment">  and other multimedia devices that is optimized for modern networking technology."  </span>
<a name="l00024"></a>00024 <span class="comment">  With OSC implemented on the Make Controller Kit, it can already talk to </span>
<a name="l00025"></a>00025 <span class="comment">  a wide variety of environments and devices like Java, Max/MSP, Pd, Flash, Processing, SuperCollider,</span>
<a name="l00026"></a>00026 <span class="comment">  and many others.</span>
<a name="l00027"></a>00027 <span class="comment">  </span>
<a name="l00028"></a>00028 <span class="comment">  OSC is based on the notion of \b messages, which are composed of an address, and the data to </span>
<a name="l00029"></a>00029 <span class="comment">  be sent to that address.  The address looks a lot like a URL that you might type into</span>
<a name="l00030"></a>00030 <span class="comment">  your internet browser.  Each element in the address is like a directory, with other </span>
<a name="l00031"></a>00031 <span class="comment">  elements inside it, and each element is separated from the next by a slash (/).  Each OSC</span>
<a name="l00032"></a>00032 <span class="comment">  message must also start with a slash.  </span>
<a name="l00033"></a>00033 <span class="comment">  </span>
<a name="l00034"></a>00034 <span class="comment">  \par Example:</span>
<a name="l00035"></a>00035 <span class="comment">  For instance, the OSC address</span>
<a name="l00036"></a>00036 <span class="comment">  \code /make/controller/kit \endcode</span>
<a name="l00037"></a>00037 <span class="comment">  says, "start in the 'make' directory, go down to the 'controller' directory, and </span>
<a name="l00038"></a>00038 <span class="comment">  finally to the 'kit' directory.  </span>
<a name="l00039"></a>00039 <span class="comment">  </span>
<a name="l00040"></a>00040 <span class="comment">  Any number of \b argument \b values can be sent to that address by including them in the message</span>
<a name="l00041"></a>00041 <span class="comment">  after the address.  These values can be integers (ints), floats, or strings.  </span>
<a name="l00042"></a>00042 <span class="comment">  </span>
<a name="l00043"></a>00043 <span class="comment">  \par Example:</span>
<a name="l00044"></a>00044 <span class="comment">  If we wanted to send the value 35.4 to the address above, we would create the message</span>
<a name="l00045"></a>00045 <span class="comment">  \code /make/controller/kit 35.4 \endcode</span>
<a name="l00046"></a>00046 <span class="comment">  with a space between the address and the data.\n\n</span>
<a name="l00047"></a>00047 <span class="comment">  Additional data can be added, each separated by a space</span>
<a name="l00048"></a>00048 <span class="comment">  \code /make/controller/kit 35.4 lawn 12 \endcode</span>
<a name="l00049"></a>00049 <span class="comment">  </span>
<a name="l00050"></a>00050 <span class="comment">  \section osc_mck OSC &amp; the Make Controller Kit</span>
<a name="l00051"></a>00051 <span class="comment">  Many devices on the Make Controller Kit can be addressed via OSC.  In sending messages to them,</span>
<a name="l00052"></a>00052 <span class="comment">  we need to know the OSC address, and the appropriate argument values to send.</span>
<a name="l00053"></a>00053 <span class="comment">  </span>
<a name="l00054"></a>00054 <span class="comment">  The Make Controller Kit is orgranized, for OSC, into \b subsystems.  Each subsystem has one or more</span>
<a name="l00055"></a>00055 <span class="comment">  \b devices, and each device has one or more \b properties.  To address a particular device, you'll</span>
<a name="l00056"></a>00056 <span class="comment">  need to create an OSC message specifying the address in that format: </span>
<a name="l00057"></a>00057 <span class="comment">  \code /subsystem/device/property \endcode</span>
<a name="l00058"></a>00058 <span class="comment">  Each of the modules above provide the details for each of the subsystems on the board, along with their</span>
<a name="l00059"></a>00059 <span class="comment">  devices and properties.  A simple example is given below.</span>
<a name="l00060"></a>00060 <span class="comment">  </span>
<a name="l00061"></a>00061 <span class="comment">  \par Example:</span>
<a name="l00062"></a>00062 <span class="comment">  To create an OSC message to turn an LED on, first identify the appropriate \b subsystem.</span>
<a name="l00063"></a>00063 <span class="comment">  In this case, the subsystem is called \b appled.\n\n</span>
<a name="l00064"></a>00064 <span class="comment">  There are 4 LEDs, so we need to specify which one to control.</span>
<a name="l00065"></a>00065 <span class="comment">  The LEDs are numbered 0 -3, so choosing the first LED means the \b device value is 0.\n\n</span>
<a name="l00066"></a>00066 <span class="comment">  The \b property of the LED that turns it on and off is its 'state'.\n\n</span>
<a name="l00067"></a>00067 <span class="comment">  Lastly, we must specify what the state should actually be, by including an \b argument value after the address.</span>
<a name="l00068"></a>00068 <span class="comment">  To turn it on, this value should be 1.  0 would turn it off.\n</span>
<a name="l00069"></a>00069 <span class="comment">  The complete OSC message looks like</span>
<a name="l00070"></a>00070 <span class="comment">  \code /appled/0/state 1 \endcode</span>
<a name="l00071"></a>00071 <span class="comment">*/</span>
<a name="l00072"></a>00072 
<a name="l00073"></a>00073 
<a name="l00074"></a>00074 <span class="preprocessor">#include "config.h"</span>
<a name="l00075"></a>00075 <span class="preprocessor">#ifdef OSC</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span>
<a name="l00077"></a>00077 <span class="preprocessor">#include "osc.h"</span>
<a name="l00078"></a>00078 <span class="preprocessor">#include "network.h"</span>
<a name="l00079"></a>00079 <span class="preprocessor">#include "rtos.h"</span>
<a name="l00080"></a>00080 <span class="preprocessor">#include "debug.h"</span>
<a name="l00081"></a>00081 <span class="preprocessor">#include "types.h"</span>
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 <span class="comment">// These for the unwrapped semaphore</span>
<a name="l00084"></a>00084 <span class="preprocessor">#include "FreeRTOS.h"</span>
<a name="l00085"></a>00085 <span class="preprocessor">#include "task.h"</span>
<a name="l00086"></a>00086 <span class="preprocessor">#include "semphr.h"</span>
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 <span class="preprocessor">#include &lt;string.h&gt;</span>
<a name="l00089"></a>00089 <span class="preprocessor">#include &lt;stdio.h&gt;</span>
<a name="l00090"></a>00090 <span class="comment">//#include &lt;stdlib.h&gt;</span>
<a name="l00091"></a>00091 <span class="preprocessor">#include &lt;ctype.h&gt;</span>
<a name="l00092"></a>00092 <span class="preprocessor">#include &lt;stdarg.h&gt;</span>
<a name="l00093"></a>00093 
<a name="l00094"></a>00094 <span class="preprocessor">#define OSC_MAX_MESSAGE_IN   200</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#define OSC_MAX_MESSAGE_OUT  600</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>
<a name="l00097"></a>00097 <span class="keyword">typedef</span> <span class="keyword">struct </span>OscChannel_
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099   <span class="keywordtype">char</span> buffer[ OSC_MAX_MESSAGE_OUT ];
<a name="l00100"></a>00100   <span class="keywordtype">char</span> incoming[ OSC_MAX_MESSAGE_IN ];
<a name="l00101"></a>00101   <span class="keywordtype">char</span>* bufferPointer;
<a name="l00102"></a>00102   <span class="keywordtype">int</span>  bufferRemaining;
<a name="l00103"></a>00103   <span class="keywordtype">int</span>  messages;
<a name="l00104"></a>00104   <span class="keywordtype">int</span> replyAddress;
<a name="l00105"></a>00105   <span class="keywordtype">int</span> replyPort;
<a name="l00106"></a>00106   int (*sendMessage)( <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length, <span class="keywordtype">int</span> replyAddress, <span class="keywordtype">int</span> replyPort );
<a name="l00107"></a>00107   xSemaphoreHandle semaphore;
<a name="l00108"></a>00108   <span class="keywordtype">int</span> running;
<a name="l00109"></a>00109 }OscChannel;
<a name="l00110"></a>00110 
<a name="l00111"></a>00111 <span class="keyword">typedef</span> <span class="keyword">struct </span>OscSubsystem_
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113   <span class="keyword">const</span> <span class="keywordtype">char</span>* name;
<a name="l00114"></a>00114   int (*receiveMessage)( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> length );  
<a name="l00115"></a>00115   int (*async)( <span class="keywordtype">int</span> channel );
<a name="l00116"></a>00116 }OscSubsystem;
<a name="l00117"></a>00117 
<a name="l00118"></a>00118 <span class="keyword">typedef</span> <span class="keyword">struct </span>Osc_
<a name="l00119"></a>00119 {
<a name="l00120"></a>00120   <span class="keywordtype">int</span> users;
<a name="l00121"></a>00121   <span class="keywordtype">int</span> running;
<a name="l00122"></a>00122   <span class="keywordtype">int</span> subsystemHighest;
<a name="l00123"></a>00123   <span class="keywordtype">void</span>* sendSocket;
<a name="l00124"></a>00124   <span class="keyword">struct </span>netconn* tcpSocket;
<a name="l00125"></a>00125   <span class="keywordtype">void</span>* UsbTaskPtr;
<a name="l00126"></a>00126   <span class="keywordtype">void</span>* UdpTaskPtr;
<a name="l00127"></a>00127   <span class="keywordtype">void</span>* TcpTaskPtr;
<a name="l00128"></a>00128   <span class="keywordtype">void</span>* AsyncTaskPtr;
<a name="l00129"></a>00129   OscChannel* channel[ OSC_CHANNEL_COUNT ];
<a name="l00130"></a>00130   OscSubsystem* subsystem[ OSC_SUBSYSTEM_COUNT ];
<a name="l00131"></a>00131   <span class="keywordtype">int</span> registeredSubsystems;
<a name="l00132"></a>00132   <span class="keywordtype">char</span> scratch1[ OSC_SCRATCH_SIZE ], scratch2[ OSC_SCRATCH_SIZE ];
<a name="l00133"></a>00133   xSemaphoreHandle scratch1Semaphore, scratch2Semaphore;
<a name="l00134"></a>00134 }OscStruct;
<a name="l00135"></a>00135 
<a name="l00136"></a>00136 OscStruct* Osc;
<a name="l00137"></a>00137 
<a name="l00138"></a>00138 <span class="keywordtype">int</span> Osc_Lock( OscChannel* ch );
<a name="l00139"></a>00139 <span class="keywordtype">void</span> Osc_Unlock( OscChannel *ch );
<a name="l00140"></a>00140 <span class="keywordtype">int</span> Osc_LockScratchBuf( xSemaphoreHandle scratchSemaphore );
<a name="l00141"></a>00141 <span class="keywordtype">int</span> Osc_UnlockScratchBuf( xSemaphoreHandle scratchSemaphore );
<a name="l00142"></a>00142 
<a name="l00143"></a>00143 <span class="keywordtype">int</span> Osc_Quicky( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* preamble, <span class="keywordtype">char</span>* <span class="keywordtype">string</span> );
<a name="l00144"></a>00144 <span class="keywordtype">char</span>* Osc_WritePaddedString( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* <span class="keywordtype">string</span> );
<a name="l00145"></a>00145 <span class="keywordtype">char</span>* Osc_WritePaddedBlob( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* blob, <span class="keywordtype">int</span> blen );
<a name="l00146"></a>00146 <span class="keywordtype">char</span>* Osc_WriteTimetag( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b );
<a name="l00147"></a>00147 <span class="keywordtype">int</span> Osc_EndianSwap( <span class="keywordtype">int</span> a );
<a name="l00148"></a>00148 <span class="keywordtype">int</span> Osc_ReceiveMessage( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length );
<a name="l00149"></a>00149 <span class="keywordtype">char</span>* Osc_CreateBundle( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b );
<a name="l00150"></a>00150 <span class="keywordtype">int</span> Osc_PropertyLookup( <span class="keywordtype">char</span>** properties, <span class="keywordtype">char</span>* property );
<a name="l00151"></a>00151 <span class="keywordtype">int</span> Osc_ReadInt( <span class="keywordtype">char</span>* buffer );
<a name="l00152"></a>00152 <span class="keywordtype">float</span> Osc_ReadFloat( <span class="keywordtype">char</span>* buffer );
<a name="l00153"></a>00153 
<a name="l00154"></a>00154 <span class="keywordtype">void</span> Osc_UdpTask( <span class="keywordtype">void</span>* parameters );
<a name="l00155"></a>00155 <span class="keywordtype">void</span> Osc_UsbTask( <span class="keywordtype">void</span>* parameters );
<a name="l00156"></a>00156 <span class="keywordtype">void</span> Osc_TcpTask( <span class="keywordtype">void</span>* parameters );
<a name="l00157"></a>00157 <span class="keywordtype">void</span> Osc_AsyncTask( <span class="keywordtype">void</span>* p );
<a name="l00158"></a>00158 <span class="keywordtype">int</span> Osc_UdpPacketSend( <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length, <span class="keywordtype">int</span> replyAddress, <span class="keywordtype">int</span> replyPort );
<a name="l00159"></a>00159 <span class="keywordtype">int</span> Osc_UsbPacketSend( <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length, <span class="keywordtype">int</span> replyAddress, <span class="keywordtype">int</span> replyPort );
<a name="l00160"></a>00160 <span class="keywordtype">int</span> Osc_TcpPacketSend( <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length, <span class="keywordtype">int</span> replyAddress, <span class="keywordtype">int</span> replyPort );
<a name="l00161"></a>00161 
<a name="l00162"></a>00162 <span class="keywordtype">void</span> Osc_ResetChannel( OscChannel* ch );
<a name="l00163"></a>00163 <span class="keywordtype">int</span> Osc_SendPacketInternal( OscChannel* ch );
<a name="l00164"></a>00164 <span class="keywordtype">int</span> Osc_SetReplyAddress( <span class="keywordtype">int</span> channel, <span class="keywordtype">int</span> replyAddress );
<a name="l00165"></a>00165 <span class="keywordtype">int</span> Osc_SetReplyPort( <span class="keywordtype">int</span> channel, <span class="keywordtype">int</span> replyPort );
<a name="l00166"></a>00166 
<a name="l00167"></a>00167 <span class="keywordtype">int</span> Osc_SendMessage( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length );
<a name="l00168"></a>00168 <span class="keywordtype">int</span> Osc_ReceivePacket( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length );
<a name="l00169"></a>00169 <span class="keywordtype">int</span> Osc_Poll( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> maxLength, <span class="keywordtype">int</span>* length );
<a name="l00170"></a>00170 
<a name="l00171"></a>00171 <span class="keywordtype">bool</span> Osc_PatternMatch(<span class="keyword">const</span> <span class="keywordtype">char</span> * pattern, <span class="keyword">const</span> <span class="keywordtype">char</span> * test); 
<a name="l00172"></a>00172 <span class="keywordtype">int</span> Osc_Quicky( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* preamble, <span class="keywordtype">char</span>* <span class="keywordtype">string</span> );
<a name="l00173"></a>00173 <span class="keywordtype">char</span>* Osc_WritePaddedString( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* <span class="keywordtype">string</span> );
<a name="l00174"></a>00174 <span class="keywordtype">char</span>* Osc_WriteTimetag( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b );
<a name="l00175"></a>00175 <span class="keywordtype">int</span> Osc_EndianSwap( <span class="keywordtype">int</span> a );
<a name="l00176"></a>00176 <span class="keywordtype">int</span> Osc_ReceiveMessage( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length );
<a name="l00177"></a>00177 <span class="keywordtype">char</span>* Osc_CreateBundle( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b );
<a name="l00178"></a>00178 <span class="keywordtype">char</span>* Osc_CreateMessageInternal( <span class="keywordtype">char</span>* bp, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* address, <span class="keywordtype">char</span>* format, va_list args );
<a name="l00179"></a>00179 <span class="keywordtype">int</span> Osc_CreateMessageToBuf( <span class="keywordtype">char</span>* bp, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* address, <span class="keywordtype">char</span>* format, ... );
<a name="l00180"></a>00180 
<a name="l00181"></a>00181 <span class="keywordtype">int</span> Osc_ReadInt( <span class="keywordtype">char</span>* buffer );
<a name="l00182"></a>00182 <span class="keywordtype">float</span> Osc_ReadFloat( <span class="keywordtype">char</span>* buffer );
<a name="l00183"></a>00183 <span class="keywordtype">int</span> Osc_UdpPacketSend( <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length, <span class="keywordtype">int</span> replyAddress, <span class="keywordtype">int</span> replyPort );
<a name="l00184"></a>00184 
<a name="l00185"></a>00185 <span class="keywordtype">int</span> OscBusy;
<a name="l00186"></a>00186 
<a name="l00187"></a>00187 <span class="comment"></span>
<a name="l00188"></a>00188 <span class="comment">/**</span>
<a name="l00189"></a>00189 <span class="comment">  Osc_SetActive.</span>
<a name="l00190"></a>00190 <span class="comment">  Sets whether the Osc system active. \n</span>
<a name="l00191"></a>00191 <span class="comment">  @param state</span>
<a name="l00192"></a>00192 <span class="comment">  @return Zero on success.</span>
<a name="l00193"></a>00193 <span class="comment">*/</span>
<a name="l00194"></a>00194 <span class="keywordtype">void</span> Osc_SetActive( <span class="keywordtype">int</span> state )
<a name="l00195"></a>00195 {
<a name="l00196"></a>00196   <span class="keywordflow">if</span> ( state &amp;&amp; Osc == NULL )
<a name="l00197"></a>00197   {
<a name="l00198"></a>00198     Osc = <a class="code" href="group___utils.html#g95923aa748602fa0330903fca05ca892" title="Same as Malloc, but keeps trying until it succeeds.">MallocWait</a>( <span class="keyword">sizeof</span>( OscStruct ), 100 );
<a name="l00199"></a>00199     Osc-&gt;subsystemHighest = 0;
<a name="l00200"></a>00200     Osc-&gt;registeredSubsystems = 0;
<a name="l00201"></a>00201     Osc-&gt;sendSocket = NULL;
<a name="l00202"></a>00202     <span class="keywordtype">int</span> i;
<a name="l00203"></a>00203     <span class="keywordflow">for</span>( i = 0; i &lt; OSC_CHANNEL_COUNT; i++ )
<a name="l00204"></a>00204       Osc-&gt;channel[ i ] = NULL;
<a name="l00205"></a>00205     <span class="keywordflow">for</span>( i = 0; i &lt; OSC_SUBSYSTEM_COUNT; i++ )
<a name="l00206"></a>00206       Osc-&gt;subsystem[ i ] = NULL;
<a name="l00207"></a>00207 
<a name="l00208"></a>00208 <span class="preprocessor">    #ifdef MAKE_CTRL_NETWORK</span>
<a name="l00209"></a>00209 <span class="preprocessor"></span><span class="preprocessor">      #ifdef CROSSWORKS_BUILD</span>
<a name="l00210"></a>00210 <span class="preprocessor"></span>      Osc-&gt;UdpTaskPtr = <a class="code" href="group___tasks.html#g784f87fb45eebb76d07478036ed228d3" title="Create a new task.">TaskCreate</a>( Osc_UdpTask, <span class="stringliteral">"OSC-UDP"</span>, 1200, (<span class="keywordtype">void</span>*)OSC_CHANNEL_UDP, 3 );
<a name="l00211"></a>00211 <span class="preprocessor">      #else // GnuArm, WinArm, YAGARTO, etc.</span>
<a name="l00212"></a>00212 <span class="preprocessor"></span>      Osc-&gt;UdpTaskPtr = <a class="code" href="group___tasks.html#g784f87fb45eebb76d07478036ed228d3" title="Create a new task.">TaskCreate</a>( Osc_UdpTask, <span class="stringliteral">"OSC-UDP"</span>, 2500, (<span class="keywordtype">void</span>*)OSC_CHANNEL_UDP, 3 );
<a name="l00213"></a>00213 <span class="preprocessor">      #endif // CROSSWORKS_BUILD</span>
<a name="l00214"></a>00214 <span class="preprocessor"></span>    Osc-&gt;TcpTaskPtr = NULL;
<a name="l00215"></a>00215 <span class="preprocessor">    #endif // MAKE_CTRL_NETWORK</span>
<a name="l00216"></a>00216 <span class="preprocessor"></span>    
<a name="l00217"></a>00217 <span class="preprocessor">    #ifdef MAKE_CTRL_USB</span>
<a name="l00218"></a>00218 <span class="preprocessor"></span><span class="preprocessor">      #ifdef CROSSWORKS_BUILD</span>
<a name="l00219"></a>00219 <span class="preprocessor"></span>      Osc-&gt;UsbTaskPtr = <a class="code" href="group___tasks.html#g784f87fb45eebb76d07478036ed228d3" title="Create a new task.">TaskCreate</a>( Osc_UsbTask, <span class="stringliteral">"OSC-USB"</span>, 1000, (<span class="keywordtype">void</span>*)OSC_CHANNEL_USB, 3 );
<a name="l00220"></a>00220 <span class="preprocessor">      #else</span>
<a name="l00221"></a>00221 <span class="preprocessor"></span>      Osc-&gt;UsbTaskPtr = <a class="code" href="group___tasks.html#g784f87fb45eebb76d07478036ed228d3" title="Create a new task.">TaskCreate</a>( Osc_UsbTask, <span class="stringliteral">"OSC-USB"</span>, 1300, (<span class="keywordtype">void</span>*)OSC_CHANNEL_USB, 3 );
<a name="l00222"></a>00222 <span class="preprocessor">      #endif // CROSSWORKS_BUILD</span>
<a name="l00223"></a>00223 <span class="preprocessor"></span><span class="preprocessor">    #endif // MAKE_CTRL_USB</span>
<a name="l00224"></a>00224 <span class="preprocessor"></span>
<a name="l00225"></a>00225 <span class="preprocessor">    #ifdef CROSSWORKS_BUILD</span>
<a name="l00226"></a>00226 <span class="preprocessor"></span>    Osc-&gt;AsyncTaskPtr = <a class="code" href="group___tasks.html#g784f87fb45eebb76d07478036ed228d3" title="Create a new task.">TaskCreate</a>( Osc_AsyncTask, <span class="stringliteral">"OSC-ASYNC"</span>, 600, 0, 2 );
<a name="l00227"></a>00227 <span class="preprocessor">    #else</span>
<a name="l00228"></a>00228 <span class="preprocessor"></span>    Osc-&gt;AsyncTaskPtr = <a class="code" href="group___tasks.html#g784f87fb45eebb76d07478036ed228d3" title="Create a new task.">TaskCreate</a>( Osc_AsyncTask, <span class="stringliteral">"OSC-ASYNC"</span>, 1100, 0, 2 );
<a name="l00229"></a>00229 <span class="preprocessor">    #endif // CROSSWORKS_BUILD</span>
<a name="l00230"></a>00230 <span class="preprocessor"></span>
<a name="l00231"></a>00231     vSemaphoreCreateBinary( Osc-&gt;scratch1Semaphore );
<a name="l00232"></a>00232     vSemaphoreCreateBinary( Osc-&gt;scratch2Semaphore );
<a name="l00233"></a>00233 
<a name="l00234"></a>00234     Osc-&gt;users = 1;
<a name="l00235"></a>00235     Osc-&gt;running = <span class="keyword">true</span>;
<a name="l00236"></a>00236   }
<a name="l00237"></a>00237   <span class="keywordflow">if</span>( !state &amp;&amp; Osc )
<a name="l00238"></a>00238   {
<a name="l00239"></a>00239 <span class="preprocessor">    #ifdef MAKE_CTRL_USB</span>
<a name="l00240"></a>00240 <span class="preprocessor"></span>    <a class="code" href="group___tasks.html#g5bc41573c59208d32d999e2f394ad3ce" title="Delete an existing task.">TaskDelete</a>( Osc-&gt;UsbTaskPtr );
<a name="l00241"></a>00241 <span class="preprocessor">    #endif</span>
<a name="l00242"></a>00242 <span class="preprocessor"></span><span class="preprocessor">    #ifdef MAKE_CTRL_NETWORK</span>
<a name="l00243"></a>00243 <span class="preprocessor"></span>    <a class="code" href="group___tasks.html#g5bc41573c59208d32d999e2f394ad3ce" title="Delete an existing task.">TaskDelete</a>( Osc-&gt;UdpTaskPtr );
<a name="l00244"></a>00244 <span class="preprocessor">    #endif</span>
<a name="l00245"></a>00245 <span class="preprocessor"></span>    <span class="keywordtype">int</span> i;
<a name="l00246"></a>00246     <span class="keywordflow">for</span>( i = 0; i &lt; OSC_CHANNEL_COUNT; i++ )
<a name="l00247"></a>00247       <a class="code" href="group___utils.html#g6b0be54448d6ce393134400f4b22fa97" title="Free memory from the heap.">Free</a>( Osc-&gt;channel[ i ] );
<a name="l00248"></a>00248     <span class="keywordflow">for</span>( i = 0; i &lt; OSC_SUBSYSTEM_COUNT; i++ )
<a name="l00249"></a>00249       <a class="code" href="group___utils.html#g6b0be54448d6ce393134400f4b22fa97" title="Free memory from the heap.">Free</a>( Osc-&gt;subsystem[ i ] );
<a name="l00250"></a>00250     <a class="code" href="group___utils.html#g6b0be54448d6ce393134400f4b22fa97" title="Free memory from the heap.">Free</a> ( Osc );
<a name="l00251"></a>00251     Osc = NULL;
<a name="l00252"></a>00252   }
<a name="l00253"></a>00253   <span class="keywordflow">return</span>;
<a name="l00254"></a>00254 }
<a name="l00255"></a>00255 <span class="comment"></span>
<a name="l00256"></a>00256 <span class="comment">/**</span>
<a name="l00257"></a>00257 <span class="comment">  Osc_GetActive.</span>
<a name="l00258"></a>00258 <span class="comment">  Returns the state of the Osc system.</span>
<a name="l00259"></a>00259 <span class="comment">  @return Non-zero if active, zero if inactive.</span>
<a name="l00260"></a>00260 <span class="comment">*/</span>
<a name="l00261"></a>00261 <span class="keywordtype">int</span> Osc_GetActive( )
<a name="l00262"></a>00262 {
<a name="l00263"></a>00263   <span class="keywordflow">return</span> Osc != NULL;
<a name="l00264"></a>00264 }
<a name="l00265"></a>00265 
<a name="l00266"></a>00266 <span class="keywordtype">int</span> Osc_GetRunning( )
<a name="l00267"></a>00267 {
<a name="l00268"></a>00268   <span class="keywordflow">if</span>( Osc )
<a name="l00269"></a>00269     <span class="keywordflow">return</span> Osc-&gt;running;
<a name="l00270"></a>00270   <span class="keywordflow">else</span>
<a name="l00271"></a>00271     <span class="keywordflow">return</span> 0;
<a name="l00272"></a>00272 }
<a name="l00273"></a>00273 
<a name="l00274"></a>00274 <span class="preprocessor">#ifdef MAKE_CTRL_NETWORK</span>
<a name="l00275"></a>00275 <span class="preprocessor"></span><span class="keywordtype">void</span> Osc_UdpTask( <span class="keywordtype">void</span>* parameters )
<a name="l00276"></a>00276 {
<a name="l00277"></a>00277   <span class="keywordtype">int</span> channel = (int)parameters;
<a name="l00278"></a>00278   Osc-&gt;channel[ channel ] = <a class="code" href="group___utils.html#g95923aa748602fa0330903fca05ca892" title="Same as Malloc, but keeps trying until it succeeds.">MallocWait</a>( <span class="keyword">sizeof</span>( OscChannel ), 100 );
<a name="l00279"></a>00279   OscChannel *ch = Osc-&gt;channel[ channel ];
<a name="l00280"></a>00280   ch-&gt;running = <span class="keyword">false</span>;
<a name="l00281"></a>00281   Osc_SetReplyPort( channel, NetworkOsc_GetUdpSendPort() );
<a name="l00282"></a>00282   ch-&gt;sendMessage = Osc_UdpPacketSend;
<a name="l00283"></a>00283   Osc_ResetChannel( ch );
<a name="l00284"></a>00284 
<a name="l00285"></a>00285   <span class="comment">// Chill until the Network is up</span>
<a name="l00286"></a>00286   <span class="keywordflow">while</span> ( !<a class="code" href="group___network.html#gb1f4725187ab9011d327ed8e05e4746c" title="Returns the active state of the Network subsystem.">Network_GetActive</a>() )
<a name="l00287"></a>00287     <a class="code" href="group___tasks.html#g9a64a7c0e24f257826103d1d1bbb44fa" title="Put a task to sleep for a given number of milliseconds.">Sleep</a>( 100 );
<a name="l00288"></a>00288 
<a name="l00289"></a>00289   <span class="keywordtype">void</span>* ds = NULL;
<a name="l00290"></a>00290   <span class="keywordflow">while</span>( ds == NULL )
<a name="l00291"></a>00291   {
<a name="l00292"></a>00292     ds = <a class="code" href="group___sockets.html#g2cd3724da41c8c8235fa648a6fc9bcce" title="Create a socket to read and write UDP packets.">DatagramSocket</a>( NetworkOsc_GetUdpListenPort() );
<a name="l00293"></a>00293     <a class="code" href="group___tasks.html#g9a64a7c0e24f257826103d1d1bbb44fa" title="Put a task to sleep for a given number of milliseconds.">Sleep</a>( 100 );
<a name="l00294"></a>00294   }
<a name="l00295"></a>00295   <span class="keywordflow">while</span>( Osc-&gt;sendSocket == NULL )
<a name="l00296"></a>00296   {
<a name="l00297"></a>00297     Osc-&gt;sendSocket = <a class="code" href="group___sockets.html#g2cd3724da41c8c8235fa648a6fc9bcce" title="Create a socket to read and write UDP packets.">DatagramSocket</a>( 0 );
<a name="l00298"></a>00298     <a class="code" href="group___tasks.html#g9a64a7c0e24f257826103d1d1bbb44fa" title="Put a task to sleep for a given number of milliseconds.">Sleep</a>( 100 );
<a name="l00299"></a>00299   }
<a name="l00300"></a>00300   
<a name="l00301"></a>00301   ch-&gt;running = <span class="keyword">true</span>;
<a name="l00302"></a>00302   <span class="keywordflow">while</span> ( <span class="keyword">true</span> )
<a name="l00303"></a>00303   {
<a name="l00304"></a>00304     <span class="keywordtype">int</span> address;
<a name="l00305"></a>00305     <span class="keywordtype">int</span> port;
<a name="l00306"></a>00306     <span class="keywordtype">int</span> length = <a class="code" href="group___sockets.html#ge810fd22358d4358b214bb99c20f363f" title="Receive a UDP packet.">DatagramSocketReceive</a>( ds, NetworkOsc_GetUdpListenPort(), &amp;address, &amp;port, ch-&gt;incoming, OSC_MAX_MESSAGE_IN );
<a name="l00307"></a>00307     <span class="keywordflow">if</span>( length &gt; 0 )
<a name="l00308"></a>00308     {
<a name="l00309"></a>00309       Osc_SetReplyAddress( channel, address );
<a name="l00310"></a>00310       Osc_ReceivePacket( channel, ch-&gt;incoming, length );
<a name="l00311"></a>00311     }
<a name="l00312"></a>00312     <a class="code" href="group___tasks.html#gbe9e0304997a15f46d9eae37be16e3f2" title="Give up the remaining time allotted to this task by the processor.">TaskYield</a>( );
<a name="l00313"></a>00313   }
<a name="l00314"></a>00314 }
<a name="l00315"></a>00315 
<a name="l00316"></a>00316 <span class="keywordtype">int</span> Osc_UdpPacketSend( <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length, <span class="keywordtype">int</span> replyAddress, <span class="keywordtype">int</span> replyPort )
<a name="l00317"></a>00317 {
<a name="l00318"></a>00318   <span class="keywordflow">if</span> ( replyAddress != 0 &amp;&amp; replyPort != 0 )
<a name="l00319"></a>00319   {
<a name="l00320"></a>00320     <span class="keywordtype">int</span> retval = <a class="code" href="group___sockets.html#g5aa01e1403bafbfca35746bcd44a5c83" title="Send a UDP packet to a specified address.">DatagramSocketSend</a>( Osc-&gt;sendSocket, replyAddress, replyPort, packet, length );
<a name="l00321"></a>00321     <span class="keywordflow">return</span> retval;
<a name="l00322"></a>00322   }
<a name="l00323"></a>00323   <span class="keywordflow">else</span>
<a name="l00324"></a>00324     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gf0c0d854039c8ccbb5fed2a35ded843b" title="Board doesn&amp;#39;t have an address.">CONTROLLER_ERROR_NO_ADDRESS</a>;
<a name="l00325"></a>00325 }
<a name="l00326"></a>00326 
<a name="l00327"></a>00327 <span class="keywordtype">void</span> Osc_StartTcpTask( )
<a name="l00328"></a>00328 {
<a name="l00329"></a>00329   Osc-&gt;TcpTaskPtr = <a class="code" href="group___tasks.html#g784f87fb45eebb76d07478036ed228d3" title="Create a new task.">TaskCreate</a>( Osc_TcpTask, <span class="stringliteral">"OscTcp"</span>, 600, 0, 2 );
<a name="l00330"></a>00330 }
<a name="l00331"></a>00331 
<a name="l00332"></a>00332 <span class="keywordtype">int</span> Osc_TcpPacketSend( <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length, <span class="keywordtype">int</span> replyAddress, <span class="keywordtype">int</span> replyPort )
<a name="l00333"></a>00333 {
<a name="l00334"></a>00334   (void)replyAddress;
<a name="l00335"></a>00335   (void)replyPort;
<a name="l00336"></a>00336   <span class="keywordtype">char</span> len[ 4 ];
<a name="l00337"></a>00337   <span class="comment">//int endian = Osc_EndianSwap(length);</span>
<a name="l00338"></a>00338   sprintf( len, <span class="stringliteral">"%d"</span>, length );
<a name="l00339"></a>00339       
<a name="l00340"></a>00340   <span class="keywordtype">int</span> result = <a class="code" href="group___sockets.html#g1031bc0757e65ea265deb5dc3ded3029" title="Write to a TCP socket.">SocketWrite</a>( Osc-&gt;tcpSocket, len, 4 );
<a name="l00341"></a>00341   result = <a class="code" href="group___sockets.html#g1031bc0757e65ea265deb5dc3ded3029" title="Write to a TCP socket.">SocketWrite</a>( Osc-&gt;tcpSocket, packet, length );
<a name="l00342"></a>00342   <span class="keywordflow">if</span>( !result )
<a name="l00343"></a>00343   {
<a name="l00344"></a>00344     <a class="code" href="group___sockets.html#geab922d85a99bd7577f5e5b54628a5b4" title="Close an existing TCP socket.">SocketClose</a>( Osc-&gt;tcpSocket );
<a name="l00345"></a>00345     Osc-&gt;tcpSocket = NULL;
<a name="l00346"></a>00346   }
<a name="l00347"></a>00347   <span class="keywordflow">return</span> result;
<a name="l00348"></a>00348 }
<a name="l00349"></a>00349 
<a name="l00350"></a>00350 <span class="keywordtype">void</span> Osc_TcpTask( <span class="keywordtype">void</span>* parameters )
<a name="l00351"></a>00351 {
<a name="l00352"></a>00352   (void)parameters;
<a name="l00353"></a>00353   Osc-&gt;channel[ OSC_CHANNEL_TCP ] = <a class="code" href="group___utils.html#g95923aa748602fa0330903fca05ca892" title="Same as Malloc, but keeps trying until it succeeds.">MallocWait</a>( <span class="keyword">sizeof</span>( OscChannel ), 100 );
<a name="l00354"></a>00354   OscChannel *ch = Osc-&gt;channel[ OSC_CHANNEL_TCP ];
<a name="l00355"></a>00355   ch-&gt;sendMessage = Osc_TcpPacketSend;
<a name="l00356"></a>00356   Osc_ResetChannel( ch );
<a name="l00357"></a>00357 
<a name="l00358"></a>00358   <span class="comment">// Chill until the Network is up</span>
<a name="l00359"></a>00359   <span class="keywordflow">while</span> ( !<a class="code" href="group___network.html#gb1f4725187ab9011d327ed8e05e4746c" title="Returns the active state of the Network subsystem.">Network_GetActive</a>() )
<a name="l00360"></a>00360     <a class="code" href="group___tasks.html#g9a64a7c0e24f257826103d1d1bbb44fa" title="Put a task to sleep for a given number of milliseconds.">Sleep</a>( 100 );
<a name="l00361"></a>00361 
<a name="l00362"></a>00362   <span class="keywordtype">int</span> ledstate = 0;
<a name="l00363"></a>00363 
<a name="l00364"></a>00364   ch-&gt;running = <span class="keyword">true</span>;
<a name="l00365"></a>00365   ch-&gt;semaphore = NULL; <span class="comment">// not sure why I need to do this here and not for the other channels...</span>
<a name="l00366"></a>00366 
<a name="l00367"></a>00367   <span class="keywordflow">while</span>( NetworkOsc_GetTcpRequested( ) )
<a name="l00368"></a>00368   {
<a name="l00369"></a>00369     <span class="comment">// check to see if we have an open socket</span>
<a name="l00370"></a>00370     <span class="keywordflow">if</span>( Osc-&gt;tcpSocket == NULL )
<a name="l00371"></a>00371       Osc-&gt;tcpSocket = <a class="code" href="group___sockets.html#g7e4b76e6d4a93aa7c281e5cbba6cc584" title="Create a new TCP socket connected to the address and port specified.">Socket</a>( NetworkOsc_GetTcpOutAddress(), NetworkOsc_GetTcpOutPort() );
<a name="l00372"></a>00372 
<a name="l00373"></a>00373     <span class="keywordflow">if</span>( Osc-&gt;tcpSocket != NULL )
<a name="l00374"></a>00374     {
<a name="l00375"></a>00375       <span class="keywordtype">int</span> length = <a class="code" href="group___sockets.html#g838d1ceaf477b3496a9fe4adf8d28147" title="Read from a TCP socket.">SocketRead</a>( Osc-&gt;tcpSocket, ch-&gt;incoming, OSC_MAX_MESSAGE_IN );
<a name="l00376"></a>00376       <span class="comment">// should actually read the given length in the message, and use that.</span>
<a name="l00377"></a>00377       <span class="keywordflow">if</span>( length &gt; 0 )
<a name="l00378"></a>00378       {
<a name="l00379"></a>00379         Osc_ReceivePacket( OSC_CHANNEL_TCP, ch-&gt;incoming+4, length-4 );
<a name="l00380"></a>00380         ledstate = !ledstate;
<a name="l00381"></a>00381       }
<a name="l00382"></a>00382         
<a name="l00383"></a>00383       <span class="keywordflow">if</span>( !length )
<a name="l00384"></a>00384       {
<a name="l00385"></a>00385         <a class="code" href="group___sockets.html#geab922d85a99bd7577f5e5b54628a5b4" title="Close an existing TCP socket.">SocketClose</a>( Osc-&gt;tcpSocket );
<a name="l00386"></a>00386         Osc-&gt;tcpSocket = NULL;
<a name="l00387"></a>00387       }
<a name="l00388"></a>00388       <a class="code" href="group___tasks.html#gbe9e0304997a15f46d9eae37be16e3f2" title="Give up the remaining time allotted to this task by the processor.">TaskYield</a>( );
<a name="l00389"></a>00389     }
<a name="l00390"></a>00390     <span class="keywordflow">else</span>
<a name="l00391"></a>00391       <a class="code" href="group___tasks.html#g9a64a7c0e24f257826103d1d1bbb44fa" title="Put a task to sleep for a given number of milliseconds.">Sleep</a>( 100 ); <span class="comment">// Just so we don't bash the Socket( ) call constantly when we're not open</span>
<a name="l00392"></a>00392   } <span class="comment">// while( )</span>
<a name="l00393"></a>00393   <span class="comment">// now we shut down</span>
<a name="l00394"></a>00394   <a class="code" href="group___sockets.html#geab922d85a99bd7577f5e5b54628a5b4" title="Close an existing TCP socket.">SocketClose</a>( Osc-&gt;tcpSocket );
<a name="l00395"></a>00395   Osc-&gt;tcpSocket = NULL;
<a name="l00396"></a>00396   Osc_ResetChannel( ch );
<a name="l00397"></a>00397   <a class="code" href="group___utils.html#g6b0be54448d6ce393134400f4b22fa97" title="Free memory from the heap.">Free</a>( Osc-&gt;channel[ OSC_CHANNEL_TCP ] );
<a name="l00398"></a>00398   Osc-&gt;channel[ OSC_CHANNEL_TCP ] = NULL;
<a name="l00399"></a>00399   <a class="code" href="group___tasks.html#g5bc41573c59208d32d999e2f394ad3ce" title="Delete an existing task.">TaskDelete</a>( Osc-&gt;TcpTaskPtr );
<a name="l00400"></a>00400 }
<a name="l00401"></a>00401 <span class="preprocessor">#endif // MAKE_CTRL_NETWORK</span>
<a name="l00402"></a>00402 <span class="preprocessor"></span>
<a name="l00403"></a>00403 <span class="preprocessor">#ifdef MAKE_CTRL_USB</span>
<a name="l00404"></a>00404 <span class="preprocessor"></span><span class="keywordtype">void</span> Osc_UsbTask( <span class="keywordtype">void</span>* parameters )
<a name="l00405"></a>00405 {
<a name="l00406"></a>00406   <span class="keywordtype">int</span> channel = (int)parameters;
<a name="l00407"></a>00407   Osc-&gt;channel[ channel ] = <a class="code" href="group___utils.html#g95923aa748602fa0330903fca05ca892" title="Same as Malloc, but keeps trying until it succeeds.">MallocWait</a>( <span class="keyword">sizeof</span>( OscChannel ), 100 );
<a name="l00408"></a>00408   OscChannel *ch = Osc-&gt;channel[ channel ];
<a name="l00409"></a>00409   ch-&gt;sendMessage = Osc_UsbPacketSend;
<a name="l00410"></a>00410   Osc_ResetChannel( ch );
<a name="l00411"></a>00411 
<a name="l00412"></a>00412   <span class="comment">// Chill until the USB connection is up</span>
<a name="l00413"></a>00413   <span class="keywordflow">while</span> ( !<a class="code" href="group___u_s_b.html#g86fb085b1eace675a46d72e58c98fa09" title="Read the active state of the Usb system.">Usb_GetActive</a>() )
<a name="l00414"></a>00414     <a class="code" href="group___tasks.html#g9a64a7c0e24f257826103d1d1bbb44fa" title="Put a task to sleep for a given number of milliseconds.">Sleep</a>( 100 );
<a name="l00415"></a>00415 
<a name="l00416"></a>00416   ch-&gt;running = <span class="keyword">true</span>;
<a name="l00417"></a>00417 
<a name="l00418"></a>00418   <span class="keywordflow">while</span> ( <span class="keyword">true</span> )
<a name="l00419"></a>00419   {
<a name="l00420"></a>00420     <span class="keywordtype">int</span> length = <a class="code" href="group___u_s_b.html#g9e3c83ebc7acfceda064b76c94c96d2a" title="Read from the USB port using SLIP codes to de-packetize messages.">Usb_SlipReceive</a>( ch-&gt;incoming, OSC_MAX_MESSAGE_IN );
<a name="l00421"></a>00421     <span class="keywordflow">if</span> ( length &gt; 0 )
<a name="l00422"></a>00422       Osc_ReceivePacket( channel, ch-&gt;incoming, length );
<a name="l00423"></a>00423     <a class="code" href="group___tasks.html#g9a64a7c0e24f257826103d1d1bbb44fa" title="Put a task to sleep for a given number of milliseconds.">Sleep</a>( 1 );
<a name="l00424"></a>00424   }
<a name="l00425"></a>00425 }
<a name="l00426"></a>00426 
<a name="l00427"></a>00427 <span class="keywordtype">int</span> Osc_UsbPacketSend( <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length, <span class="keywordtype">int</span> replyAddress, <span class="keywordtype">int</span> replyPort )
<a name="l00428"></a>00428 {
<a name="l00429"></a>00429   (void)replyAddress;
<a name="l00430"></a>00430   (void)replyPort;
<a name="l00431"></a>00431   <span class="keywordflow">return</span> <a class="code" href="group___u_s_b.html#g83237266412f310be1779ff07110acdc" title="Write to the USB port using SLIP codes to packetize messages.">Usb_SlipSend</a>( packet, length );
<a name="l00432"></a>00432 }
<a name="l00433"></a>00433 <span class="preprocessor">#endif // MAKE_CTRL_USB</span>
<a name="l00434"></a>00434 <span class="preprocessor"></span>
<a name="l00435"></a>00435 <span class="keywordtype">void</span> Osc_AsyncTask( <span class="keywordtype">void</span>* p )
<a name="l00436"></a>00436 {
<a name="l00437"></a>00437   (void)p;
<a name="l00438"></a>00438   <span class="keywordtype">int</span> channel;
<a name="l00439"></a>00439   <span class="keywordtype">int</span> i;
<a name="l00440"></a>00440   OscSubsystem* sub;
<a name="l00441"></a>00441   <span class="keywordtype">int</span> newMsgs = 0;
<a name="l00442"></a>00442   <span class="keywordflow">while</span>( 1 )
<a name="l00443"></a>00443   {
<a name="l00444"></a>00444     channel = System_GetAsyncDestination( );
<a name="l00445"></a>00445     <span class="keywordflow">if</span>( channel &gt;= 0 )
<a name="l00446"></a>00446     {
<a name="l00447"></a>00447       <span class="keywordflow">for</span>( i = 0; i &lt; Osc-&gt;registeredSubsystems; i++ )
<a name="l00448"></a>00448       {
<a name="l00449"></a>00449         sub = Osc-&gt;subsystem[ i ];
<a name="l00450"></a>00450         <span class="keywordflow">if</span>( sub-&gt;async != NULL )
<a name="l00451"></a>00451           newMsgs += (sub-&gt;async)( channel );   
<a name="l00452"></a>00452       }
<a name="l00453"></a>00453       <span class="keywordflow">if</span>( newMsgs &gt; 0 )
<a name="l00454"></a>00454       {
<a name="l00455"></a>00455         Osc_SendPacket( channel );
<a name="l00456"></a>00456         newMsgs = 0;
<a name="l00457"></a>00457       }
<a name="l00458"></a>00458       <a class="code" href="group___tasks.html#g9a64a7c0e24f257826103d1d1bbb44fa" title="Put a task to sleep for a given number of milliseconds.">Sleep</a>( System_GetAutoSendInterval( ) );
<a name="l00459"></a>00459     }
<a name="l00460"></a>00460     <span class="keywordflow">else</span>
<a name="l00461"></a>00461       <a class="code" href="group___tasks.html#g9a64a7c0e24f257826103d1d1bbb44fa" title="Put a task to sleep for a given number of milliseconds.">Sleep</a>( 1000 );
<a name="l00462"></a>00462   }
<a name="l00463"></a>00463 }
<a name="l00464"></a>00464 
<a name="l00465"></a>00465 <span class="keywordtype">int</span> Osc_SetReplyAddress( <span class="keywordtype">int</span> channel, <span class="keywordtype">int</span> replyAddress )
<a name="l00466"></a>00466 {
<a name="l00467"></a>00467   <span class="keywordflow">if</span> ( channel &lt; 0 || channel &gt;= OSC_CHANNEL_COUNT )
<a name="l00468"></a>00468     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>;
<a name="l00469"></a>00469 
<a name="l00470"></a>00470   OscChannel* ch =  Osc-&gt;channel[ channel ];
<a name="l00471"></a>00471 
<a name="l00472"></a>00472   ch-&gt;replyAddress = replyAddress;
<a name="l00473"></a>00473 
<a name="l00474"></a>00474   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00475"></a>00475 }
<a name="l00476"></a>00476 
<a name="l00477"></a>00477 <span class="keywordtype">int</span> Osc_SetReplyPort( <span class="keywordtype">int</span> channel, <span class="keywordtype">int</span> replyPort )
<a name="l00478"></a>00478 {
<a name="l00479"></a>00479   <span class="keywordflow">if</span> ( channel &lt; 0 || channel &gt;= OSC_CHANNEL_COUNT )
<a name="l00480"></a>00480     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>;
<a name="l00481"></a>00481 
<a name="l00482"></a>00482   OscChannel* ch =  Osc-&gt;channel[ channel ];
<a name="l00483"></a>00483 
<a name="l00484"></a>00484   ch-&gt;replyPort = replyPort;
<a name="l00485"></a>00485 
<a name="l00486"></a>00486   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00487"></a>00487 }
<a name="l00488"></a>00488 
<a name="l00489"></a>00489 <span class="keywordtype">void</span> Osc_ResetChannel( OscChannel* ch )
<a name="l00490"></a>00490 {
<a name="l00491"></a>00491   ch-&gt;bufferPointer = ch-&gt;buffer;
<a name="l00492"></a>00492   ch-&gt;bufferRemaining = OSC_MAX_MESSAGE_OUT;
<a name="l00493"></a>00493   ch-&gt;messages = 0;
<a name="l00494"></a>00494 }
<a name="l00495"></a>00495 
<a name="l00496"></a>00496 <span class="keywordtype">int</span> Osc_SendMessage( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length )
<a name="l00497"></a>00497 {
<a name="l00498"></a>00498   (void)channel;
<a name="l00499"></a>00499   (void)message;
<a name="l00500"></a>00500   (void)length;
<a name="l00501"></a>00501   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00502"></a>00502 }
<a name="l00503"></a>00503 
<a name="l00504"></a>00504 <span class="keywordtype">int</span> Osc_ReceivePacket( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length )
<a name="l00505"></a>00505 {
<a name="l00506"></a>00506   <span class="comment">// Got a packet.  Unpacket.</span>
<a name="l00507"></a>00507   <span class="keywordtype">int</span> status = -1;
<a name="l00508"></a>00508   <span class="keywordflow">switch</span> ( *packet )
<a name="l00509"></a>00509   {
<a name="l00510"></a>00510     <span class="keywordflow">case</span> <span class="charliteral">'/'</span>:
<a name="l00511"></a>00511       status = Osc_ReceiveMessage( channel, packet, length );
<a name="l00512"></a>00512       <span class="keywordflow">break</span>;
<a name="l00513"></a>00513     <span class="keywordflow">case</span> <span class="charliteral">'#'</span>:
<a name="l00514"></a>00514       <span class="keywordflow">if</span> ( strcmp( packet, <span class="stringliteral">"#bundle"</span> ) == 0 )
<a name="l00515"></a>00515       {
<a name="l00516"></a>00516         <span class="comment">// skip bundle text and timetag</span>
<a name="l00517"></a>00517         packet += 16;
<a name="l00518"></a>00518         length -= 16;
<a name="l00519"></a>00519         <span class="keywordflow">while</span> ( length &gt; 0 )
<a name="l00520"></a>00520         {
<a name="l00521"></a>00521           <span class="comment">// read the length (pretend packet is a pointer to integer)</span>
<a name="l00522"></a>00522           <span class="keywordtype">int</span> messageLength = Osc_EndianSwap( *((<span class="keywordtype">int</span>*)packet) );
<a name="l00523"></a>00523           packet += 4;
<a name="l00524"></a>00524           length -= 4;
<a name="l00525"></a>00525           <span class="keywordflow">if</span> ( messageLength &lt;= length )
<a name="l00526"></a>00526             Osc_ReceivePacket( channel, packet, messageLength );
<a name="l00527"></a>00527           length -= messageLength;
<a name="l00528"></a>00528           packet += messageLength;
<a name="l00529"></a>00529         }
<a name="l00530"></a>00530       }
<a name="l00531"></a>00531       <span class="keywordflow">break</span>;
<a name="l00532"></a>00532     <span class="keywordflow">default</span>:
<a name="l00533"></a>00533       <span class="comment">// Something else?</span>
<a name="l00534"></a>00534       Osc_CreateMessage( channel, <span class="stringliteral">"/error"</span>, <span class="stringliteral">",s"</span>, <span class="stringliteral">"Packet Error"</span> );
<a name="l00535"></a>00535       <span class="keywordflow">break</span>;
<a name="l00536"></a>00536   }
<a name="l00537"></a>00537 
<a name="l00538"></a>00538   <span class="keywordflow">return</span> Osc_SendPacket( channel );
<a name="l00539"></a>00539 }
<a name="l00540"></a>00540 
<a name="l00541"></a>00541 <span class="keywordtype">int</span> Osc_ReceiveMessage( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length )
<a name="l00542"></a>00542 {
<a name="l00543"></a>00543   <span class="comment">// Got a packet.  Unpacket.</span>
<a name="l00544"></a>00544 
<a name="l00545"></a>00545   <span class="comment">// Confirm it's a message</span>
<a name="l00546"></a>00546   <span class="keywordflow">if</span> ( *message == <span class="charliteral">'/'</span> )
<a name="l00547"></a>00547   {
<a name="l00548"></a>00548     <span class="keywordflow">if</span>( strlen(message) &gt; (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>)length )
<a name="l00549"></a>00549       <span class="keywordflow">return</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>;
<a name="l00550"></a>00550 
<a name="l00551"></a>00551     <span class="keywordtype">int</span> i;
<a name="l00552"></a>00552     <span class="keywordtype">char</span>* nextChar = message + 1; <span class="comment">// first, try to see if it was a "help" query</span>
<a name="l00553"></a>00553     <span class="keywordflow">if</span>( *nextChar == <span class="charliteral">'\0'</span> || *nextChar == <span class="charliteral">' '</span> )
<a name="l00554"></a>00554     {
<a name="l00555"></a>00555       <span class="keywordflow">for</span> ( i = 0; i &lt; Osc-&gt;registeredSubsystems; i++ )
<a name="l00556"></a>00556       {
<a name="l00557"></a>00557         OscSubsystem* sub = Osc-&gt;subsystem[ i ];
<a name="l00558"></a>00558         Osc_CreateMessage( channel, <span class="stringliteral">"/"</span>, <span class="stringliteral">",s"</span>, sub-&gt;name );
<a name="l00559"></a>00559       }
<a name="l00560"></a>00560       <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00561"></a>00561     }
<a name="l00562"></a>00562 
<a name="l00563"></a>00563     <span class="keywordtype">char</span>* nextSlash = strchr( message + 1, <span class="charliteral">'/'</span> );
<a name="l00564"></a>00564     <span class="keywordflow">if</span> ( nextSlash != NULL )
<a name="l00565"></a>00565       *nextSlash = 0;
<a name="l00566"></a>00566     
<a name="l00567"></a>00567     <span class="keywordtype">int</span> count = 0;
<a name="l00568"></a>00568     <span class="keywordflow">for</span> ( i = 0; i &lt; Osc-&gt;registeredSubsystems; i++ )
<a name="l00569"></a>00569     {
<a name="l00570"></a>00570       OscSubsystem* sub = Osc-&gt;subsystem[ i ];
<a name="l00571"></a>00571       <span class="keywordflow">if</span> ( Osc_PatternMatch( message + 1, sub-&gt;name ) )
<a name="l00572"></a>00572       {
<a name="l00573"></a>00573         count++;
<a name="l00574"></a>00574         <span class="keywordflow">if</span> ( nextSlash )
<a name="l00575"></a>00575           (sub-&gt;receiveMessage)( channel, nextSlash + 1, length - ( nextSlash - message ) - 1 );
<a name="l00576"></a>00576         <span class="keywordflow">else</span>
<a name="l00577"></a>00577         {
<a name="l00578"></a>00578           <span class="keywordtype">char</span>* noNextSlash = message + strlen(message);
<a name="l00579"></a>00579           (sub-&gt;receiveMessage)( channel, noNextSlash, 0 );
<a name="l00580"></a>00580         }
<a name="l00581"></a>00581       }
<a name="l00582"></a>00582     }
<a name="l00583"></a>00583     <span class="keywordflow">if</span> ( count == 0 )
<a name="l00584"></a>00584     {
<a name="l00585"></a>00585       Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l00586"></a>00586       snprintf( Osc-&gt;scratch1, OSC_SCRATCH_SIZE, <span class="stringliteral">"No Subsystem Match - %s"</span>, message + 1 );
<a name="l00587"></a>00587       Osc_CreateMessage( channel, <span class="stringliteral">"/error"</span>, <span class="stringliteral">",s"</span>, Osc-&gt;scratch1 );
<a name="l00588"></a>00588       Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l00589"></a>00589     }
<a name="l00590"></a>00590   }
<a name="l00591"></a>00591   <span class="keywordflow">else</span>
<a name="l00592"></a>00592   {
<a name="l00593"></a>00593     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>;
<a name="l00594"></a>00594   }
<a name="l00595"></a>00595   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00596"></a>00596 }
<a name="l00597"></a>00597 
<a name="l00598"></a>00598 <span class="keywordtype">int</span> Osc_SendPacket( <span class="keywordtype">int</span> channel )
<a name="l00599"></a>00599 {
<a name="l00600"></a>00600   <span class="keywordflow">if</span> ( channel &lt; 0 || channel &gt;= OSC_CHANNEL_COUNT )
<a name="l00601"></a>00601     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>;
<a name="l00602"></a>00602 
<a name="l00603"></a>00603   OscChannel* ch = Osc-&gt;channel[ channel ];
<a name="l00604"></a>00604 
<a name="l00605"></a>00605   <span class="keywordflow">if</span> ( ch-&gt;messages == 0 )
<a name="l00606"></a>00606     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00607"></a>00607 
<a name="l00608"></a>00608   <span class="keywordflow">if</span> ( Osc_Lock( ch ) != <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a> )
<a name="l00609"></a>00609     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g266dd00cf91a01e73619d6e6b2c5ed83" title="An error occurred while trying to lock.">CONTROLLER_ERROR_LOCK_ERROR</a>;
<a name="l00610"></a>00610 
<a name="l00611"></a>00611   <span class="keywordtype">int</span> ret = Osc_SendPacketInternal( ch );
<a name="l00612"></a>00612 
<a name="l00613"></a>00613   Osc_Unlock( ch );
<a name="l00614"></a>00614 
<a name="l00615"></a>00615   <span class="keywordflow">return</span> ret;
<a name="l00616"></a>00616 }
<a name="l00617"></a>00617 
<a name="l00618"></a>00618 <span class="keywordtype">int</span> Osc_SendPacketInternal( OscChannel* ch )
<a name="l00619"></a>00619 {
<a name="l00620"></a>00620   <span class="keywordflow">if</span> ( ch-&gt;messages == 0 )
<a name="l00621"></a>00621     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00622"></a>00622 
<a name="l00623"></a>00623   <span class="comment">// set the buffer and length up</span>
<a name="l00624"></a>00624   <span class="keywordtype">char</span>* buffer = ch-&gt;buffer;
<a name="l00625"></a>00625   <span class="keywordtype">int</span> length = OSC_MAX_MESSAGE_OUT - ch-&gt;bufferRemaining;
<a name="l00626"></a>00626 
<a name="l00627"></a>00627   <span class="comment">// see if we can dispense with the bundle business</span>
<a name="l00628"></a>00628   <span class="keywordflow">if</span> ( ch-&gt;messages == 1 )
<a name="l00629"></a>00629   {
<a name="l00630"></a>00630     <span class="comment">// skip 8 bytes of "#bundle" and 8 bytes of timetag and 4 bytes of size</span>
<a name="l00631"></a>00631     buffer += 20;
<a name="l00632"></a>00632     <span class="comment">// shorter too</span>
<a name="l00633"></a>00633     length -= 20;
<a name="l00634"></a>00634   }
<a name="l00635"></a>00635   (*ch-&gt;sendMessage)( buffer, length, ch-&gt;replyAddress, ch-&gt;replyPort );
<a name="l00636"></a>00636 
<a name="l00637"></a>00637   Osc_ResetChannel( ch );
<a name="l00638"></a>00638 
<a name="l00639"></a>00639   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00640"></a>00640 }
<a name="l00641"></a>00641 
<a name="l00642"></a>00642 <span class="keywordtype">int</span> Osc_Poll( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> maxLength, <span class="keywordtype">int</span>* length )
<a name="l00643"></a>00643 {
<a name="l00644"></a>00644   (void)buffer;
<a name="l00645"></a>00645   (void)maxLength;
<a name="l00646"></a>00646   (void)length;
<a name="l00647"></a>00647   (void)channel;
<a name="l00648"></a>00648   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00649"></a>00649 }
<a name="l00650"></a>00650 
<a name="l00651"></a>00651 <span class="keywordtype">int</span> Osc_Quicky( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* preamble, <span class="keywordtype">char</span>* <span class="keywordtype">string</span> )
<a name="l00652"></a>00652 {
<a name="l00653"></a>00653   <span class="keywordflow">return</span> Osc_CreateMessage( channel, <span class="stringliteral">"/debug"</span>, <span class="stringliteral">",ss"</span>, preamble, <span class="keywordtype">string</span> );
<a name="l00654"></a>00654 }
<a name="l00655"></a>00655 <span class="comment"></span>
<a name="l00656"></a>00656 <span class="comment">/** @defgroup OSCAPI OSC API</span>
<a name="l00657"></a>00657 <span class="comment">  Make use of the OSC infrastructure for your own subsystems.</span>
<a name="l00658"></a>00658 <span class="comment">  You can use the existing OSC infrastructure to create your own OSC subsystems.  It's expected that you'll have</span>
<a name="l00659"></a>00659 <span class="comment">  a few things lined up to use this API:</span>
<a name="l00660"></a>00660 <span class="comment">  -# The name of your subsystem</span>
<a name="l00661"></a>00661 <span class="comment">  -# The properties that your subsystem will support.  This must be in an array with '0' as the last element.</span>
<a name="l00662"></a>00662 <span class="comment">  -# Getters and setters for each of those properties and functions to call them by property index.</span>
<a name="l00663"></a>00663 <span class="comment">  -# A function to call the correct helper when Osc calls you. </span>
<a name="l00664"></a>00664 <span class="comment">  -# Finally, once you've done all this, you'll need to add your subsystem to the list that Osc knows about.</span>
<a name="l00665"></a>00665 <span class="comment">  </span>
<a name="l00666"></a>00666 <span class="comment">  \par Example</span>
<a name="l00667"></a>00667 <span class="comment">  So this might look something like:</span>
<a name="l00668"></a>00668 <span class="comment">  \code</span>
<a name="l00669"></a>00669 <span class="comment">  // our system name and a function to get it</span>
<a name="l00670"></a>00670 <span class="comment">  static char* MySubsystemOsc_Name = "my-system";</span>
<a name="l00671"></a>00671 <span class="comment">  const char* MySubsystemOsc_GetName( void )</span>
<a name="l00672"></a>00672 <span class="comment">  {</span>
<a name="l00673"></a>00673 <span class="comment">    return MySubsystemOsc_Name;</span>
<a name="l00674"></a>00674 <span class="comment">  }</span>
<a name="l00675"></a>00675 <span class="comment">  </span>
<a name="l00676"></a>00676 <span class="comment">  // our property names</span>
<a name="l00677"></a>00677 <span class="comment">  static char* MySubsystemOsc_PropertyNames[] = { "prop0", "prop1", 0 }; // must end with a zero</span>
<a name="l00678"></a>00678 <span class="comment">  </span>
<a name="l00679"></a>00679 <span class="comment">  // A getter and setter, each dealing with the property given to us by the OSC system</span>
<a name="l00680"></a>00680 <span class="comment">  int MyGPSOsc_PropertySet( int index, int property, int value )   </span>
<a name="l00681"></a>00681 <span class="comment">  {</span>
<a name="l00682"></a>00682 <span class="comment">    switch ( property )     </span>
<a name="l00683"></a>00683 <span class="comment">    {       </span>
<a name="l00684"></a>00684 <span class="comment">      case 0:         </span>
<a name="l00685"></a>00685 <span class="comment">        MySubsystem_SetProperty0( index, value );</span>
<a name="l00686"></a>00686 <span class="comment">        break;</span>
<a name="l00687"></a>00687 <span class="comment">      case 1:</span>
<a name="l00688"></a>00688 <span class="comment">        MySubsystem_SetProperty1( index, value );</span>
<a name="l00689"></a>00689 <span class="comment">        break;</span>
<a name="l00690"></a>00690 <span class="comment">     }</span>
<a name="l00691"></a>00691 <span class="comment">    return CONTROLLER_OK;</span>
<a name="l00692"></a>00692 <span class="comment">  }</span>
<a name="l00693"></a>00693 <span class="comment"></span>
<a name="l00694"></a>00694 <span class="comment">  int MySubsystemOsc_PropertyGet( int index, int property )</span>
<a name="l00695"></a>00695 <span class="comment">  {</span>
<a name="l00696"></a>00696 <span class="comment">    int value;</span>
<a name="l00697"></a>00697 <span class="comment">     switch ( property )</span>
<a name="l00698"></a>00698 <span class="comment">     {</span>
<a name="l00699"></a>00699 <span class="comment">      case 0:</span>
<a name="l00700"></a>00700 <span class="comment">        value = MySubsystem_GetProperty0( index );</span>
<a name="l00701"></a>00701 <span class="comment">        break;</span>
<a name="l00702"></a>00702 <span class="comment">      case 1:</span>
<a name="l00703"></a>00703 <span class="comment">        value = MySubsystem_GetProperty1( index );</span>
<a name="l00704"></a>00704 <span class="comment">        break;</span>
<a name="l00705"></a>00705 <span class="comment">    }</span>
<a name="l00706"></a>00706 <span class="comment">    return value;</span>
<a name="l00707"></a>00707 <span class="comment">  }</span>
<a name="l00708"></a>00708 <span class="comment">  </span>
<a name="l00709"></a>00709 <span class="comment">  // this is called when the OSC system determines an incoming message is for you.</span>
<a name="l00710"></a>00710 <span class="comment">  int MySubsystemOsc_ReceiveMessage( int channel, char* message, int length )</span>
<a name="l00711"></a>00711 <span class="comment">  {  </span>
<a name="l00712"></a>00712 <span class="comment">     // depending on your subsystem, use one of the OSC helpers to parse the incoming message</span>
<a name="l00713"></a>00713 <span class="comment">     return Osc_IndexGeneralReceiverHelper( channel, message, length,</span>
<a name="l00714"></a>00714 <span class="comment">                                        MySubsystemOsc_Name,</span>
<a name="l00715"></a>00715 <span class="comment">                                        MySubsystemOsc_PropertySet,</span>
<a name="l00716"></a>00716 <span class="comment">                                        MySubsystemOsc_PropertyGet,</span>
<a name="l00717"></a>00717 <span class="comment">                                        MySubsystemOsc_PropertyNames );</span>
<a name="l00718"></a>00718 <span class="comment">  }</span>
<a name="l00719"></a>00719 <span class="comment">   </span>
<a name="l00720"></a>00720 <span class="comment">  // lastly, we'll need to register our system with OSC</span>
<a name="l00721"></a>00721 <span class="comment">  Run( ) // this is our startup task in make.c</span>
<a name="l00722"></a>00722 <span class="comment">  {</span>
<a name="l00723"></a>00723 <span class="comment">    // other startup stuff</span>
<a name="l00724"></a>00724 <span class="comment">    Osc_RegisterSubsystem( MySubsystemOsc_GetName(), MySubsystemOsc_ReceiveMessage, NULL );</span>
<a name="l00725"></a>00725 <span class="comment">  }</span>
<a name="l00726"></a>00726 <span class="comment">  \endcode</span>
<a name="l00727"></a>00727 <span class="comment">  </span>
<a name="l00728"></a>00728 <span class="comment">  Check the how-to at http://www.makingthings.com/documentation/how-to/create-your-own-osc-subsystem for details.</span>
<a name="l00729"></a>00729 <span class="comment">  </span>
<a name="l00730"></a>00730 <span class="comment">  \ingroup Controller </span>
<a name="l00731"></a>00731 <span class="comment">*/</span>
<a name="l00732"></a>00732 <span class="comment"></span>
<a name="l00733"></a>00733 <span class="comment">/** </span>
<a name="l00734"></a>00734 <span class="comment">  Register your subsystem with the OSC system.</span>
<a name="l00735"></a>00735 <span class="comment">  You'll usually want to do this on startup.</span>
<a name="l00736"></a>00736 <span class="comment">  @param name The name of your subsystem.</span>
<a name="l00737"></a>00737 <span class="comment">  @param subsystem_ReceiveMessage The function to call when an OSC message for this subsystem has arrived.</span>
<a name="l00738"></a>00738 <span class="comment">  @param subsystem_Async The function to be called by the OSC Async system.  This is a task that will call you at regular intervals,</span>
<a name="l00739"></a>00739 <span class="comment">  if enabled, so you can check for status changes and send a message out automatically if you like.  See the analog in source for </span>
<a name="l00740"></a>00740 <span class="comment">  an example.  Pass in NULL if you don't want to use the Async system.</span>
<a name="l00741"></a>00741 <span class="comment">  \ingroup OSCAPI</span>
<a name="l00742"></a>00742 <span class="comment"></span>
<a name="l00743"></a>00743 <span class="comment">  \par Example</span>
<a name="l00744"></a>00744 <span class="comment">  \code</span>
<a name="l00745"></a>00745 <span class="comment">  Run( ) // this is our startup task in make.c</span>
<a name="l00746"></a>00746 <span class="comment">  {</span>
<a name="l00747"></a>00747 <span class="comment">    // other startup stuff</span>
<a name="l00748"></a>00748 <span class="comment">    Osc_RegisterSubsystem( MySubsystemOsc_GetName(), MySubsystemOsc_ReceiveMessage, NULL );</span>
<a name="l00749"></a>00749 <span class="comment">  }</span>
<a name="l00750"></a>00750 <span class="comment">  \endcode</span>
<a name="l00751"></a>00751 <span class="comment">*/</span>
<a name="l00752"></a><a class="code" href="group___o_s_c_a_p_i.html#g75a7ad99079437eb1b12ea25752540af">00752</a> <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#g75a7ad99079437eb1b12ea25752540af" title="Register your subsystem with the OSC system.">Osc_RegisterSubsystem</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> (*subsystem_ReceiveMessage)( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> length ), <span class="keywordtype">int</span> (*subsystem_Async)( <span class="keywordtype">int</span> channel ) )
<a name="l00753"></a>00753 {
<a name="l00754"></a>00754   <span class="keywordtype">int</span> subsystem = Osc-&gt;registeredSubsystems;
<a name="l00755"></a>00755   <span class="keywordflow">if</span> ( Osc-&gt;registeredSubsystems++ &gt; OSC_SUBSYSTEM_COUNT )
<a name="l00756"></a>00756     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>; 
<a name="l00757"></a>00757 
<a name="l00758"></a>00758   Osc-&gt;subsystem[ subsystem ] = <a class="code" href="group___utils.html#g95923aa748602fa0330903fca05ca892" title="Same as Malloc, but keeps trying until it succeeds.">MallocWait</a>( <span class="keyword">sizeof</span>( OscSubsystem ), 100 );
<a name="l00759"></a>00759   OscSubsystem* sub = Osc-&gt;subsystem[ subsystem ];
<a name="l00760"></a>00760   sub-&gt;name = name;
<a name="l00761"></a>00761   sub-&gt;receiveMessage = subsystem_ReceiveMessage;
<a name="l00762"></a>00762   sub-&gt;async = subsystem_Async;
<a name="l00763"></a>00763   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00764"></a>00764 }
<a name="l00765"></a>00765 <span class="comment"></span>
<a name="l00766"></a>00766 <span class="comment">/** </span>
<a name="l00767"></a>00767 <span class="comment">  Send an error back via OSC from your subsystem.</span>
<a name="l00768"></a>00768 <span class="comment">  You'll usually want to call this when the OSC system calls you with a new message, you've tried to</span>
<a name="l00769"></a>00769 <span class="comment">  parse it, and you've gotten an error.</span>
<a name="l00770"></a>00770 <span class="comment">  @param channel An index for which OSC channel is being used (usually USB or Ethernet).  Usually provided for you </span>
<a name="l00771"></a>00771 <span class="comment">  by the OSC system.</span>
<a name="l00772"></a>00772 <span class="comment">  @param subsystem The name of the subsystem sending the error.</span>
<a name="l00773"></a>00773 <span class="comment">  @param string The actual contents of the error message.</span>
<a name="l00774"></a>00774 <span class="comment">  \ingroup OSCAPI</span>
<a name="l00775"></a>00775 <span class="comment"></span>
<a name="l00776"></a>00776 <span class="comment">  \par Example</span>
<a name="l00777"></a>00777 <span class="comment">  \code</span>
<a name="l00778"></a>00778 <span class="comment">  // this is where OSC calls us when an incoming message for us has arrived</span>
<a name="l00779"></a>00779 <span class="comment">  int MySubsystemOsc_ReceiveMessage( int channel, char* message, int length )</span>
<a name="l00780"></a>00780 <span class="comment">  {</span>
<a name="l00781"></a>00781 <span class="comment">    int status = Osc_IntReceiverHelper( channel, message, length,</span>
<a name="l00782"></a>00782 <span class="comment">                                        MySubsystemOsc_Name,</span>
<a name="l00783"></a>00783 <span class="comment">                                        MySubsystemOsc_PropertySet, MySubsystemOsc_PropertyGet, </span>
<a name="l00784"></a>00784 <span class="comment">                                        MySubsystemOsc_PropertyNames );</span>
<a name="l00785"></a>00785 <span class="comment"></span>
<a name="l00786"></a>00786 <span class="comment">    if ( status != CONTROLLER_OK )</span>
<a name="l00787"></a>00787 <span class="comment">      Osc_SubsystemError( channel, MySubsystemOsc_Name, "Oh no. Bad data." );</span>
<a name="l00788"></a>00788 <span class="comment">  }</span>
<a name="l00789"></a>00789 <span class="comment">  \endcode</span>
<a name="l00790"></a>00790 <span class="comment">*/</span>
<a name="l00791"></a><a class="code" href="group___o_s_c_a_p_i.html#g852200f3d0612d90d73e9f233392ec2d">00791</a> <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#g852200f3d0612d90d73e9f233392ec2d" title="Send an error back via OSC from your subsystem.">Osc_SubsystemError</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* subsystem, <span class="keywordtype">char</span>* <span class="keywordtype">string</span> )
<a name="l00792"></a>00792 {
<a name="l00793"></a>00793   <span class="keywordtype">int</span> retval;
<a name="l00794"></a>00794   Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l00795"></a>00795   snprintf( Osc-&gt;scratch1, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s/error"</span>, subsystem ); 
<a name="l00796"></a>00796   retval = Osc_CreateMessage( channel, Osc-&gt;scratch1, <span class="stringliteral">",s"</span>, <span class="keywordtype">string</span> );
<a name="l00797"></a>00797   Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l00798"></a>00798   <span class="keywordflow">return</span> retval;
<a name="l00799"></a>00799 }
<a name="l00800"></a>00800 
<a name="l00801"></a>00801 <span class="comment"></span>
<a name="l00802"></a>00802 <span class="comment">/** </span>
<a name="l00803"></a>00803 <span class="comment">  Receive an OSC blob for a subsystem with no indexes.</span>
<a name="l00804"></a>00804 <span class="comment">  You'll usually want to call this when the OSC system calls you with a new message. </span>
<a name="l00805"></a>00805 <span class="comment">  @param channel An index for which OSC channel is being used (usually USB or Ethernet).  Usually provided for you </span>
<a name="l00806"></a>00806 <span class="comment">  by the OSC system.</span>
<a name="l00807"></a>00807 <span class="comment">  @param message The OSC message being received.  Usually provided for you by the OSC system.</span>
<a name="l00808"></a>00808 <span class="comment">  @param length The length of the incoming message.  Usually provided for you by the OSC system.</span>
<a name="l00809"></a>00809 <span class="comment">  @param subsystemName The name of your subsystem.</span>
<a name="l00810"></a>00810 <span class="comment">  @param blobPropertySet A pointer to the function to be called in order to write a property of your subsystem.</span>
<a name="l00811"></a>00811 <span class="comment">  @param blobPropertyGet A pointer to the function to be called in order to read a property of your subsystem.</span>
<a name="l00812"></a>00812 <span class="comment">  @param blobPropertyNames An array of all the property names in your subsystem.</span>
<a name="l00813"></a>00813 <span class="comment">  \ingroup OSCAPI</span>
<a name="l00814"></a>00814 <span class="comment"></span>
<a name="l00815"></a>00815 <span class="comment">  \par Example</span>
<a name="l00816"></a>00816 <span class="comment">  \code</span>
<a name="l00817"></a>00817 <span class="comment">  // this is where OSC calls us when an incoming message for us has arrived</span>
<a name="l00818"></a>00818 <span class="comment">  int MySubsystemOsc_ReceiveMessage( int channel, char* message, int length )</span>
<a name="l00819"></a>00819 <span class="comment">  {</span>
<a name="l00820"></a>00820 <span class="comment">    int status = Osc_BlobReceiverHelper( channel, message, length, </span>
<a name="l00821"></a>00821 <span class="comment">                                      MySubsystemOsc_Name,</span>
<a name="l00822"></a>00822 <span class="comment">                                      MySubsystemOsc_BlobPropertySet, MySubsystemOsc_BlobPropertyGet, </span>
<a name="l00823"></a>00823 <span class="comment">                                      MySubsystemOsc_BlobPropertyNames );                        </span>
<a name="l00824"></a>00824 <span class="comment"></span>
<a name="l00825"></a>00825 <span class="comment">    if ( status != CONTROLLER_OK )</span>
<a name="l00826"></a>00826 <span class="comment">      return Osc_SendError( channel, MySubsystemOsc_Name, status );</span>
<a name="l00827"></a>00827 <span class="comment">    return CONTROLLER_OK;</span>
<a name="l00828"></a>00828 <span class="comment">  }</span>
<a name="l00829"></a>00829 <span class="comment">  \endcode</span>
<a name="l00830"></a>00830 <span class="comment">*/</span>
<a name="l00831"></a><a class="code" href="group___o_s_c_a_p_i.html#g52a8d83512751817b3a4f9f123495fb0">00831</a> <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#g52a8d83512751817b3a4f9f123495fb0" title="Receive an OSC blob for a subsystem with no indexes.">Osc_BlobReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l00832"></a>00832                            <span class="keywordtype">char</span>* subsystemName, 
<a name="l00833"></a>00833                            <span class="keywordtype">int</span> (*blobPropertySet)( <span class="keywordtype">int</span> property, uchar* buffer, <span class="keywordtype">int</span> length ),
<a name="l00834"></a>00834                            <span class="keywordtype">int</span> (*blobPropertyGet)( <span class="keywordtype">int</span> property, uchar* buffer, <span class="keywordtype">int</span> size ),
<a name="l00835"></a>00835                            <span class="keywordtype">char</span>* blobPropertyNames[] )
<a name="l00836"></a>00836 {
<a name="l00837"></a>00837   <span class="keywordflow">if</span> ( message == NULL )
<a name="l00838"></a>00838     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gb3106333ec6e45c789ae5cef04cceba2" title="No OSC property specified.">CONTROLLER_ERROR_NO_PROPERTY</a>;
<a name="l00839"></a>00839 
<a name="l00840"></a>00840   <span class="keywordtype">int</span> propertyIndex = Osc_PropertyLookup( blobPropertyNames, message );
<a name="l00841"></a>00841   <span class="keywordflow">if</span> ( propertyIndex == -1 )
<a name="l00842"></a>00842     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g1eef1eb7b55330584d5119c8283b0d0f" title="Property specified is not valid.">CONTROLLER_ERROR_UNKNOWN_PROPERTY</a>;
<a name="l00843"></a>00843 
<a name="l00844"></a>00844   <span class="comment">// Sometime after the address, the data tag begins - this is the description </span>
<a name="l00845"></a>00845   <span class="comment">// of the data in the rest of the message.  It starts with a comma.  Return</span>
<a name="l00846"></a>00846   <span class="comment">// where it is into 'type'.  If there is no comma, this is bad.</span>
<a name="l00847"></a>00847   <span class="keywordtype">char</span>* type = Osc_FindDataTag( message, length );
<a name="l00848"></a>00848   <span class="keywordflow">if</span> ( type == NULL )
<a name="l00849"></a>00849     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g2a3701fc1ba39056b9926cfab8c622f4" title="Couldn&amp;#39;t find the type tag in this OSC message.">CONTROLLER_ERROR_NO_TYPE_TAG</a>;
<a name="l00850"></a>00850 
<a name="l00851"></a>00851   <span class="comment">// We can tell if there's data by seeing if the character after the comma</span>
<a name="l00852"></a>00852   <span class="comment">// is a zero or not.</span>
<a name="l00853"></a>00853   <span class="keywordflow">if</span> ( type[ 1 ] != 0 )
<a name="l00854"></a>00854   {
<a name="l00855"></a>00855     <span class="keywordflow">if</span> ( type[ 1 ] == <span class="charliteral">'b'</span> )
<a name="l00856"></a>00856     {
<a name="l00857"></a>00857       <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer;
<a name="l00858"></a>00858       <span class="keywordtype">int</span> size;
<a name="l00859"></a>00859       <span class="keywordtype">int</span> count = Osc_ExtractData( type, <span class="stringliteral">"b"</span>, &amp;buffer, &amp;size );
<a name="l00860"></a>00860       <span class="keywordflow">if</span> ( count != 1 )
<a name="l00861"></a>00861         <span class="keywordflow">return</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>;
<a name="l00862"></a>00862     
<a name="l00863"></a>00863       (*blobPropertySet)( propertyIndex, buffer, size );
<a name="l00864"></a>00864     }
<a name="l00865"></a>00865     <span class="keywordflow">else</span>
<a name="l00866"></a>00866     {
<a name="l00867"></a>00867       <span class="keywordflow">if</span> ( type[ 1 ] == <span class="charliteral">'s'</span> )
<a name="l00868"></a>00868       {
<a name="l00869"></a>00869         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer;
<a name="l00870"></a>00870         <span class="keywordtype">int</span> count = Osc_ExtractData( type, <span class="stringliteral">"s"</span>, &amp;buffer );
<a name="l00871"></a>00871         <span class="keywordflow">if</span> ( count != 1 )
<a name="l00872"></a>00872           <span class="keywordflow">return</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>;
<a name="l00873"></a>00873     
<a name="l00874"></a>00874         (*blobPropertySet)( propertyIndex, buffer, strlen( (<span class="keywordtype">char</span>*)buffer ) );
<a name="l00875"></a>00875       }
<a name="l00876"></a>00876       <span class="keywordflow">else</span>
<a name="l00877"></a>00877         <span class="keywordflow">return</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>;
<a name="l00878"></a>00878     }
<a name="l00879"></a>00879       
<a name="l00880"></a>00880   }
<a name="l00881"></a>00881   <span class="keywordflow">else</span>
<a name="l00882"></a>00882   {
<a name="l00883"></a>00883     <span class="comment">// No data, then.  I guess it was a read.  The XXXXOsc getters</span>
<a name="l00884"></a>00884     <span class="comment">// take the channel number and use it to call</span>
<a name="l00885"></a>00885     <span class="comment">// Osc_CreateMessage() which adds a new message to the outgoing</span>
<a name="l00886"></a>00886     <span class="comment">// stack</span>
<a name="l00887"></a>00887     Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l00888"></a>00888     Osc_LockScratchBuf( Osc-&gt;scratch2Semaphore );
<a name="l00889"></a>00889     <span class="keywordtype">int</span> size = (*blobPropertyGet)( propertyIndex, (uchar*)Osc-&gt;scratch1, OSC_SCRATCH_SIZE );
<a name="l00890"></a>00890     snprintf( Osc-&gt;scratch2, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s/%s"</span>, subsystemName, blobPropertyNames[ propertyIndex ] ); 
<a name="l00891"></a>00891     Osc_CreateMessage( channel, Osc-&gt;scratch2, <span class="stringliteral">",b"</span>, Osc-&gt;scratch1, size );
<a name="l00892"></a>00892     Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l00893"></a>00893     Osc_UnlockScratchBuf( Osc-&gt;scratch2Semaphore );
<a name="l00894"></a>00894   }
<a name="l00895"></a>00895 
<a name="l00896"></a>00896   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l00897"></a>00897 }
<a name="l00898"></a>00898 <span class="comment"></span>
<a name="l00899"></a>00899 <span class="comment">/** </span>
<a name="l00900"></a>00900 <span class="comment">  Receive an OSC blob for a subsystem with indexes.</span>
<a name="l00901"></a>00901 <span class="comment">  You'll usually want to call this when the OSC system calls you with a new message. </span>
<a name="l00902"></a>00902 <span class="comment">  @param channel An index for which OSC channel is being used (usually USB or Ethernet).  Usually provided for you </span>
<a name="l00903"></a>00903 <span class="comment">  by the OSC system.</span>
<a name="l00904"></a>00904 <span class="comment">  @param message The OSC message being received.  Usually provided for you by the OSC system.</span>
<a name="l00905"></a>00905 <span class="comment">  @param length The length of the incoming message.  Usually provided for you by the OSC system.</span>
<a name="l00906"></a>00906 <span class="comment">  @param indexCount The number of indexes in your subsystem.</span>
<a name="l00907"></a>00907 <span class="comment">  @param subsystemName The name of your subsystem.</span>
<a name="l00908"></a>00908 <span class="comment">  @param blobPropertySet A pointer to the function to be called in order to write a property of your subsystem.</span>
<a name="l00909"></a>00909 <span class="comment">  @param blobPropertyGet A pointer to the function to be called in order to read a property of your subsystem.</span>
<a name="l00910"></a>00910 <span class="comment">  @param blobPropertyNames An array of all the property names in your subsystem.</span>
<a name="l00911"></a>00911 <span class="comment">  \ingroup OSCAPI</span>
<a name="l00912"></a>00912 <span class="comment"></span>
<a name="l00913"></a>00913 <span class="comment">  \par Example</span>
<a name="l00914"></a>00914 <span class="comment">  \code</span>
<a name="l00915"></a>00915 <span class="comment">  // this is where OSC calls us when an incoming message for us has arrived</span>
<a name="l00916"></a>00916 <span class="comment">  int MySubsystemOsc_ReceiveMessage( int channel, char* message, int length )</span>
<a name="l00917"></a>00917 <span class="comment">  {</span>
<a name="l00918"></a>00918 <span class="comment">    int status = Osc_IndexBlobReceiverHelper( channel, message, length, 2,</span>
<a name="l00919"></a>00919 <span class="comment">                                        MySubsystemOsc_Name,</span>
<a name="l00920"></a>00920 <span class="comment">                                        MySubsystemOsc_BlobPropertySet, MySubsystemOsc_BlobPropertyGet, </span>
<a name="l00921"></a>00921 <span class="comment">                                        MySubsystemOsc_BlobPropertyNames );</span>
<a name="l00922"></a>00922 <span class="comment"></span>
<a name="l00923"></a>00923 <span class="comment">    if ( status != CONTROLLER_OK )</span>
<a name="l00924"></a>00924 <span class="comment">      return Osc_SendError( channel, MySubsystemOsc_Name, status );</span>
<a name="l00925"></a>00925 <span class="comment">    return CONTROLLER_OK;</span>
<a name="l00926"></a>00926 <span class="comment">  }</span>
<a name="l00927"></a>00927 <span class="comment">  \endcode</span>
<a name="l00928"></a>00928 <span class="comment">*/</span>
<a name="l00929"></a><a class="code" href="group___o_s_c_a_p_i.html#gd6d4ee5a60624c22a31e0b59e560326c">00929</a> <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#gd6d4ee5a60624c22a31e0b59e560326c" title="Receive an OSC blob for a subsystem with indexes.">Osc_IndexBlobReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l00930"></a>00930                                 <span class="keywordtype">int</span> indexCount, <span class="keywordtype">char</span>* subsystemName, 
<a name="l00931"></a>00931                                 <span class="keywordtype">int</span> (*blobPropertySet)( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property, uchar* buffer, <span class="keywordtype">int</span> length ),
<a name="l00932"></a>00932                                 <span class="keywordtype">int</span> (*blobPropertyGet)( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property, uchar* buffer, <span class="keywordtype">int</span> length ),
<a name="l00933"></a>00933                                 <span class="keywordtype">char</span>* blobPropertyNames[] )
<a name="l00934"></a>00934 {
<a name="l00935"></a>00935   <span class="comment">// Look for the next slash - being the one that separates the index</span>
<a name="l00936"></a>00936   <span class="comment">// from the property.  Note that this won't go off on a search through the buffer</span>
<a name="l00937"></a>00937   <span class="comment">// since there will soon be a string terminator (i.e. a 0)</span>
<a name="l00938"></a>00938   <span class="keywordtype">char</span>* prop = strchr( message, <span class="charliteral">'/'</span> );
<a name="l00939"></a>00939   <span class="keywordflow">if</span> ( prop == NULL )
<a name="l00940"></a>00940     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g63cf0068b15b50e26b6f52c0914f968c" title="Data passed in the wrong format.">CONTROLLER_ERROR_BAD_FORMAT</a>;
<a name="l00941"></a>00941 
<a name="l00942"></a>00942   <span class="comment">// Now that we know where the property is, we can see if we can find it.</span>
<a name="l00943"></a>00943   <span class="comment">// This is a little cheap, since we're also implying that there are no </span>
<a name="l00944"></a>00944   <span class="comment">// more address terms after the property.  That is, if testing for "speed", while</span>
<a name="l00945"></a>00945   <span class="comment">// "speed" would match, "speed/other_stuff" would not.</span>
<a name="l00946"></a>00946   <span class="keywordtype">int</span> propertyIndex = Osc_PropertyLookup( blobPropertyNames, prop + 1 );
<a name="l00947"></a>00947   <span class="keywordflow">if</span> ( propertyIndex == -1 )
<a name="l00948"></a>00948     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g1eef1eb7b55330584d5119c8283b0d0f" title="Property specified is not valid.">CONTROLLER_ERROR_UNKNOWN_PROPERTY</a>;
<a name="l00949"></a>00949 
<a name="l00950"></a>00950   <span class="comment">// Here's where we try to understand what index we got.  In the world of </span>
<a name="l00951"></a>00951   <span class="comment">// OSC, this could be a pattern.  So while we could get "0/speed" we could </span>
<a name="l00952"></a>00952   <span class="comment">// also get "*/speed" or "[0-4]/speed".  This is kind of a drag, but it is </span>
<a name="l00953"></a>00953   <span class="comment">// quite nice from the user's perspective.</span>
<a name="l00954"></a>00954   <span class="comment">// So to deal with this take a look at the text "0" or "{1,2}" or whatever</span>
<a name="l00955"></a>00955   <span class="comment">// and produce either a nice integer in the simplest case or a set of bits </span>
<a name="l00956"></a>00956   <span class="comment">// where each bit corresponds to one of the indicies.  Clearly we don't have</span>
<a name="l00957"></a>00957   <span class="comment">// to go crazy, since there are only a small finite number of them.</span>
<a name="l00958"></a>00958   <span class="comment">// Osc_NumberMatch() does the work for us, producing either number = -1 and </span>
<a name="l00959"></a>00959   <span class="comment">// bits == -1 if there was no index match, or number != -1 for there was a single</span>
<a name="l00960"></a>00960   <span class="comment">// number, or bits != -1 if there were several.</span>
<a name="l00961"></a>00961 
<a name="l00962"></a>00962   <span class="comment">// note that we tweak the string a bit here to make sure the next '/' is not </span>
<a name="l00963"></a>00963   <span class="comment">// mixed up with this.  Insert a string terminator.</span>
<a name="l00964"></a>00964   *prop = 0;
<a name="l00965"></a>00965 
<a name="l00966"></a>00966   <span class="keywordtype">int</span> bits;
<a name="l00967"></a>00967   <span class="keywordtype">int</span> number = Osc_NumberMatch( indexCount, message, &amp;bits );
<a name="l00968"></a>00968   <span class="keywordflow">if</span> ( number == -1 &amp;&amp; bits == -1 )
<a name="l00969"></a>00969     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>;
<a name="l00970"></a>00970   
<a name="l00971"></a>00971   <span class="comment">// We tweaked the '/' before - now put it back</span>
<a name="l00972"></a>00972   *prop = <span class="charliteral">'/'</span>;
<a name="l00973"></a>00973 
<a name="l00974"></a>00974   <span class="comment">// Sometime after the address, the data tag begins - this is the description </span>
<a name="l00975"></a>00975   <span class="comment">// of the data in the rest of the message.  It starts with a comma.  Return</span>
<a name="l00976"></a>00976   <span class="comment">// where it is into 'type'.  If there is no comma, this is bad.</span>
<a name="l00977"></a>00977   <span class="keywordtype">char</span>* type = Osc_FindDataTag( message, length );
<a name="l00978"></a>00978   <span class="keywordflow">if</span> ( type == NULL )
<a name="l00979"></a>00979     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g2a3701fc1ba39056b9926cfab8c622f4" title="Couldn&amp;#39;t find the type tag in this OSC message.">CONTROLLER_ERROR_NO_TYPE_TAG</a>;
<a name="l00980"></a>00980 
<a name="l00981"></a>00981   <span class="comment">// We can tell if there's data by seeing if the character after the comma</span>
<a name="l00982"></a>00982   <span class="comment">// is a zero or not.</span>
<a name="l00983"></a>00983   <span class="keywordflow">if</span> ( type[ 1 ] == <span class="charliteral">'b'</span> || type[ 1 ] == <span class="charliteral">'s'</span> )
<a name="l00984"></a>00984   {
<a name="l00985"></a>00985     <span class="comment">// If there was blob or string data, it was a WRITE.</span>
<a name="l00986"></a>00986     <span class="comment">// So, sort of scanf-like, go get the data.  Here we pass in where the data is</span>
<a name="l00987"></a>00987     <span class="comment">// thanks to the previous routine and then specify what we expect to find there</span>
<a name="l00988"></a>00988     <span class="comment">// in tag terms (i.e. "b", "s").  Finally we pass in a set </span>
<a name="l00989"></a>00989     <span class="comment">// of pointers to the data types we want to extract.  Osc_ExtractData()</span>
<a name="l00990"></a>00990     <span class="comment">// will rummage around in the message magically grabbing values for you,</span>
<a name="l00991"></a>00991     <span class="comment">// reporting how many it got.  It will grab convert strings if necessary.</span>
<a name="l00992"></a>00992     <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer;
<a name="l00993"></a>00993     <span class="keywordtype">int</span> size;
<a name="l00994"></a>00994     <span class="keywordtype">int</span> count = Osc_ExtractData( type, <span class="stringliteral">"b"</span>, &amp;buffer, &amp;size );
<a name="l00995"></a>00995     <span class="keywordflow">if</span> ( count != 1 )
<a name="l00996"></a>00996       <span class="keywordflow">return</span> <a class="code" href="group___error.html#g80c66236574d73ade9c2ef53e5e4200b" title="OSC data type is not valid.">CONTROLLER_ERROR_INCORRECT_DATA_TYPE</a>;
<a name="l00997"></a>00997   
<a name="l00998"></a>00998     <span class="comment">// Now with the data we need to decide what to do with it.</span>
<a name="l00999"></a>00999     <span class="comment">// Is there one or many here?</span>
<a name="l01000"></a>01000     <span class="keywordflow">if</span> ( number != -1 )
<a name="l01001"></a>01001       (*blobPropertySet)( number, propertyIndex, buffer, size );
<a name="l01002"></a>01002     <span class="keywordflow">else</span>
<a name="l01003"></a>01003     {
<a name="l01004"></a>01004       <span class="keywordtype">int</span> index = 0;
<a name="l01005"></a>01005       <span class="keywordflow">while</span> ( bits &gt; 0 &amp;&amp; index &lt; indexCount )
<a name="l01006"></a>01006       { 
<a name="l01007"></a>01007         <span class="keywordflow">if</span> ( bits &amp; 1 )
<a name="l01008"></a>01008           (*blobPropertySet)( index, propertyIndex, buffer, size  );
<a name="l01009"></a>01009         bits &gt;&gt;= 1;
<a name="l01010"></a>01010         index++;
<a name="l01011"></a>01011       }
<a name="l01012"></a>01012     }
<a name="l01013"></a>01013   }
<a name="l01014"></a>01014   <span class="keywordflow">else</span>
<a name="l01015"></a>01015   {
<a name="l01016"></a>01016     <span class="comment">// No data, then.  I guess it was a read.  The XXXXOsc getters</span>
<a name="l01017"></a>01017     <span class="comment">// take the channel number and use it to call</span>
<a name="l01018"></a>01018     <span class="comment">// Osc_CreateMessage() which adds a new message to the outgoing</span>
<a name="l01019"></a>01019     <span class="comment">// stack</span>
<a name="l01020"></a>01020     <span class="keywordflow">if</span> ( number != -1 )
<a name="l01021"></a>01021     {
<a name="l01022"></a>01022       Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01023"></a>01023       Osc_LockScratchBuf( Osc-&gt;scratch2Semaphore );
<a name="l01024"></a>01024       <span class="keywordtype">int</span> size = (*blobPropertyGet)( number, propertyIndex, (uchar*)Osc-&gt;scratch1, OSC_SCRATCH_SIZE );
<a name="l01025"></a>01025       snprintf( Osc-&gt;scratch2, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s/%d/%s"</span>, subsystemName, number, blobPropertyNames[ propertyIndex ] ); 
<a name="l01026"></a>01026       Osc_CreateMessage( channel, Osc-&gt;scratch2, <span class="stringliteral">",b"</span>, Osc-&gt;scratch1, size );
<a name="l01027"></a>01027       Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01028"></a>01028       Osc_UnlockScratchBuf( Osc-&gt;scratch2Semaphore );
<a name="l01029"></a>01029     }
<a name="l01030"></a>01030     <span class="keywordflow">else</span>
<a name="l01031"></a>01031     {
<a name="l01032"></a>01032       <span class="keywordtype">int</span> index = 0;
<a name="l01033"></a>01033       <span class="keywordflow">while</span> ( bits &gt; 0 &amp;&amp; index &lt; indexCount )
<a name="l01034"></a>01034       { 
<a name="l01035"></a>01035         <span class="keywordflow">if</span> ( bits &amp; 1 )
<a name="l01036"></a>01036         {
<a name="l01037"></a>01037           Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01038"></a>01038           Osc_LockScratchBuf( Osc-&gt;scratch2Semaphore );
<a name="l01039"></a>01039           <span class="keywordtype">int</span> size = (*blobPropertyGet)( index, propertyIndex, (uchar*)Osc-&gt;scratch1, OSC_SCRATCH_SIZE );
<a name="l01040"></a>01040           snprintf( Osc-&gt;scratch2, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s/%d/%s"</span>, subsystemName, index, blobPropertyNames[ propertyIndex ] ); 
<a name="l01041"></a>01041           Osc_CreateMessage( channel, Osc-&gt;scratch2, <span class="stringliteral">",b"</span>, Osc-&gt;scratch1, size );
<a name="l01042"></a>01042           Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01043"></a>01043           Osc_UnlockScratchBuf( Osc-&gt;scratch2Semaphore );
<a name="l01044"></a>01044         }
<a name="l01045"></a>01045         bits &gt;&gt;= 1;
<a name="l01046"></a>01046         index++;
<a name="l01047"></a>01047       }
<a name="l01048"></a>01048     }
<a name="l01049"></a>01049   }
<a name="l01050"></a>01050 
<a name="l01051"></a>01051   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01052"></a>01052 }
<a name="l01053"></a>01053 <span class="comment"></span>
<a name="l01054"></a>01054 <span class="comment">/** </span>
<a name="l01055"></a>01055 <span class="comment">  Receive an integer for a subsystem with no indexes.</span>
<a name="l01056"></a>01056 <span class="comment">  You'll usually want to call this when the OSC system calls you with a new message. </span>
<a name="l01057"></a>01057 <span class="comment">  @param channel An index for which OSC channel is being used (usually USB or Ethernet).  Usually provided for you </span>
<a name="l01058"></a>01058 <span class="comment">  by the OSC system.</span>
<a name="l01059"></a>01059 <span class="comment">  @param message The OSC message being received.  Usually provided for you by the OSC system.</span>
<a name="l01060"></a>01060 <span class="comment">  @param length The length of the incoming message.  Usually provided for you by the OSC system.</span>
<a name="l01061"></a>01061 <span class="comment">  @param subsystemName The name of your subsystem.</span>
<a name="l01062"></a>01062 <span class="comment">  @param propertySet A pointer to the function to be called in order to write a property of your subsystem.</span>
<a name="l01063"></a>01063 <span class="comment">  @param propertyGet A pointer to the function to be called in order to read a property of your subsystem.</span>
<a name="l01064"></a>01064 <span class="comment">  @param propertyNames An array of all the property names in your subsystem.</span>
<a name="l01065"></a>01065 <span class="comment">  \ingroup OSCAPI</span>
<a name="l01066"></a>01066 <span class="comment"></span>
<a name="l01067"></a>01067 <span class="comment">  \par Example</span>
<a name="l01068"></a>01068 <span class="comment">  \code</span>
<a name="l01069"></a>01069 <span class="comment">  // this is where OSC calls us when an incoming message for us has arrived</span>
<a name="l01070"></a>01070 <span class="comment">  int MySubsystemOsc_ReceiveMessage( int channel, char* message, int length )</span>
<a name="l01071"></a>01071 <span class="comment">  {</span>
<a name="l01072"></a>01072 <span class="comment">    int status = Osc_IntReceiverHelper( channel, message, length,</span>
<a name="l01073"></a>01073 <span class="comment">                                        MySubsystemOsc_Name,</span>
<a name="l01074"></a>01074 <span class="comment">                                        MySubsystemOsc_PropertySet, MySubsystemOsc_PropertyGet, </span>
<a name="l01075"></a>01075 <span class="comment">                                        MySubsystemOsc_PropertyNames );</span>
<a name="l01076"></a>01076 <span class="comment"></span>
<a name="l01077"></a>01077 <span class="comment">    if ( status != CONTROLLER_OK )</span>
<a name="l01078"></a>01078 <span class="comment">      return Osc_SendError( channel, MySubsystemOsc_Name, status );</span>
<a name="l01079"></a>01079 <span class="comment">    return CONTROLLER_OK;</span>
<a name="l01080"></a>01080 <span class="comment">  }</span>
<a name="l01081"></a>01081 <span class="comment">  \endcode</span>
<a name="l01082"></a>01082 <span class="comment">*/</span>
<a name="l01083"></a><a class="code" href="group___o_s_c_a_p_i.html#g9331ca23d8e81ba91c4e728f0470627e">01083</a> <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#g9331ca23d8e81ba91c4e728f0470627e" title="Receive an integer for a subsystem with no indexes.">Osc_IntReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l01084"></a>01084                            <span class="keywordtype">char</span>* subsystemName, 
<a name="l01085"></a>01085                            <span class="keywordtype">int</span> (*propertySet)( <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> value ),
<a name="l01086"></a>01086                            <span class="keywordtype">int</span> (*propertyGet)( <span class="keywordtype">int</span> property ),
<a name="l01087"></a>01087                            <span class="keywordtype">char</span>* propertyNames[] )
<a name="l01088"></a>01088 {
<a name="l01089"></a>01089   <span class="keywordflow">if</span>( *message == <span class="charliteral">'\0'</span> || *message == <span class="charliteral">' '</span> ) <span class="comment">// first, try to see if it was a property "help" query</span>
<a name="l01090"></a>01090   {
<a name="l01091"></a>01091     <span class="keywordtype">int</span> i = 0;
<a name="l01092"></a>01092     <span class="keywordflow">while</span>( <span class="keyword">true</span> )
<a name="l01093"></a>01093     {
<a name="l01094"></a>01094       <span class="keywordflow">if</span>( propertyNames[i] != 0 )
<a name="l01095"></a>01095       {
<a name="l01096"></a>01096         Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01097"></a>01097         snprintf( Osc-&gt;scratch1, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s"</span>, subsystemName ); 
<a name="l01098"></a>01098         Osc_CreateMessage( channel, Osc-&gt;scratch1, <span class="stringliteral">",s"</span>, propertyNames[i] );
<a name="l01099"></a>01099         Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01100"></a>01100         i++;
<a name="l01101"></a>01101       }
<a name="l01102"></a>01102       <span class="keywordflow">else</span>
<a name="l01103"></a>01103         <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01104"></a>01104     }
<a name="l01105"></a>01105   }
<a name="l01106"></a>01106 
<a name="l01107"></a>01107   <span class="keywordtype">int</span> propertyIndex = Osc_PropertyLookup( propertyNames, message );
<a name="l01108"></a>01108   <span class="keywordflow">if</span> ( propertyIndex == -1 )
<a name="l01109"></a>01109     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g1eef1eb7b55330584d5119c8283b0d0f" title="Property specified is not valid.">CONTROLLER_ERROR_UNKNOWN_PROPERTY</a>;
<a name="l01110"></a>01110 
<a name="l01111"></a>01111 <span class="comment">/*</span>
<a name="l01112"></a>01112 <span class="comment">  int bits;</span>
<a name="l01113"></a>01113 <span class="comment">  int number = Osc_NumberMatch( indexCount, message, &amp;bits );</span>
<a name="l01114"></a>01114 <span class="comment">  if ( number == -1 &amp;&amp; bits == -1 )</span>
<a name="l01115"></a>01115 <span class="comment">    return Osc_SubsystemError( channel, subsystemName, "Bad index" );</span>
<a name="l01116"></a>01116 <span class="comment">*/</span>
<a name="l01117"></a>01117   
<a name="l01118"></a>01118   <span class="comment">// Sometime after the address, the data tag begins - this is the description </span>
<a name="l01119"></a>01119   <span class="comment">// of the data in the rest of the message.  It starts with a comma.  Return</span>
<a name="l01120"></a>01120   <span class="comment">// where it is into 'type'.  If there is no comma, this is bad.</span>
<a name="l01121"></a>01121   <span class="keywordtype">char</span>* type = Osc_FindDataTag( message, length );
<a name="l01122"></a>01122   <span class="keywordflow">if</span> ( type == NULL )
<a name="l01123"></a>01123     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g2a3701fc1ba39056b9926cfab8c622f4" title="Couldn&amp;#39;t find the type tag in this OSC message.">CONTROLLER_ERROR_NO_TYPE_TAG</a>;
<a name="l01124"></a>01124 
<a name="l01125"></a>01125   <span class="comment">// We can tell if there's data by seeing if the character after the comma</span>
<a name="l01126"></a>01126   <span class="comment">// is a zero or not.</span>
<a name="l01127"></a>01127   <span class="keywordflow">if</span> ( type[ 1 ] == <span class="charliteral">'i'</span> || type[ 1 ] == <span class="charliteral">'f'</span> )
<a name="l01128"></a>01128   {
<a name="l01129"></a>01129     <span class="comment">// If there was int or float data, it was a WRITE.</span>
<a name="l01130"></a>01130     <span class="comment">// So, sort of scanff-like, go get the data.  Here we pass in where the data is</span>
<a name="l01131"></a>01131     <span class="comment">// thanks to the previous routine and then specify what we expect to find there</span>
<a name="l01132"></a>01132     <span class="comment">// in tag terms (i.e. "i", "s", "f" and others).  Finally we pass in a set </span>
<a name="l01133"></a>01133     <span class="comment">// of pointers to the data types we want to extract.  Osc_ExtractData()</span>
<a name="l01134"></a>01134     <span class="comment">// will rummage around in the message magically grabbing values for you,</span>
<a name="l01135"></a>01135     <span class="comment">// reporting how many it got.  It will convert ints and floats if necessary.</span>
<a name="l01136"></a>01136     <span class="keywordtype">int</span> value;
<a name="l01137"></a>01137     <span class="keywordtype">int</span> count = Osc_ExtractData( type, <span class="stringliteral">"i"</span>, &amp;value );
<a name="l01138"></a>01138     <span class="keywordflow">if</span> ( count != 1 )
<a name="l01139"></a>01139       <span class="keywordflow">return</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>;
<a name="l01140"></a>01140   
<a name="l01141"></a>01141     (*propertySet)( propertyIndex, value );
<a name="l01142"></a>01142   }
<a name="l01143"></a>01143   <span class="keywordflow">else</span>
<a name="l01144"></a>01144   {
<a name="l01145"></a>01145     <span class="comment">// No data, then.  I guess it was a read.  The XXXXOsc getters</span>
<a name="l01146"></a>01146     <span class="comment">// take the channel number and use it to call</span>
<a name="l01147"></a>01147     <span class="comment">// Osc_CreateMessage() which adds a new message to the outgoing</span>
<a name="l01148"></a>01148     <span class="comment">// stack</span>
<a name="l01149"></a>01149     <span class="keywordtype">int</span> value = (*propertyGet)( propertyIndex );
<a name="l01150"></a>01150     Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01151"></a>01151     snprintf( Osc-&gt;scratch1, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s/%s"</span>, subsystemName, propertyNames[ propertyIndex ] ); 
<a name="l01152"></a>01152     Osc_CreateMessage( channel, Osc-&gt;scratch1, <span class="stringliteral">",i"</span>, value );
<a name="l01153"></a>01153     Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01154"></a>01154   }
<a name="l01155"></a>01155 
<a name="l01156"></a>01156   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01157"></a>01157 }
<a name="l01158"></a>01158 <span class="comment"></span>
<a name="l01159"></a>01159 <span class="comment">/** </span>
<a name="l01160"></a>01160 <span class="comment">  Receive data for a subsystem that receives a variety of different data types.</span>
<a name="l01161"></a>01161 <span class="comment">  An example of this kind of situation is the network system - you have a variety of different properties, </span>
<a name="l01162"></a>01162 <span class="comment">  several of which are both ints and strings.</span>
<a name="l01163"></a>01163 <span class="comment">  </span>
<a name="l01164"></a>01164 <span class="comment">  You'll usually want to call this when the OSC system calls you with a new message. </span>
<a name="l01165"></a>01165 <span class="comment">  @param channel An index for which OSC channel is being used (usually USB or Ethernet).  Usually provided for you </span>
<a name="l01166"></a>01166 <span class="comment">  by the OSC system.</span>
<a name="l01167"></a>01167 <span class="comment">  @param message The OSC message being received.  Usually provided for you by the OSC system.</span>
<a name="l01168"></a>01168 <span class="comment">  @param length The length of the incoming message.  Usually provided for you by the OSC system.</span>
<a name="l01169"></a>01169 <span class="comment">  @param subsystemName The name of your subsystem.</span>
<a name="l01170"></a>01170 <span class="comment">  @param propertySet A pointer to the function to be called in order to write a property of your subsystem.</span>
<a name="l01171"></a>01171 <span class="comment">  @param propertyGet A pointer to the function to be called in order to read a property of your subsystem.</span>
<a name="l01172"></a>01172 <span class="comment">  @param propertyNames An array of all the property names in your subsystem.</span>
<a name="l01173"></a>01173 <span class="comment">  \ingroup OSCAPI</span>
<a name="l01174"></a>01174 <span class="comment"></span>
<a name="l01175"></a>01175 <span class="comment">  \par Example</span>
<a name="l01176"></a>01176 <span class="comment">  \code</span>
<a name="l01177"></a>01177 <span class="comment">  // this is where OSC calls us when an incoming message for us has arrived</span>
<a name="l01178"></a>01178 <span class="comment">  int MySubsystemOsc_ReceiveMessage( int channel, char* message, int length )</span>
<a name="l01179"></a>01179 <span class="comment">  {</span>
<a name="l01180"></a>01180 <span class="comment">    int status = Osc_GeneralReceiverHelper( channel, message, length,</span>
<a name="l01181"></a>01181 <span class="comment">                                        MySubsystemOsc_Name,</span>
<a name="l01182"></a>01182 <span class="comment">                                        MySubsystemOsc_PropertySet, MySubsystemOsc_PropertyGet, </span>
<a name="l01183"></a>01183 <span class="comment">                                        MySubsystemOsc_PropertyNames );</span>
<a name="l01184"></a>01184 <span class="comment"></span>
<a name="l01185"></a>01185 <span class="comment">    if ( status != CONTROLLER_OK )</span>
<a name="l01186"></a>01186 <span class="comment">      return Osc_SendError( channel, MySubsystemOsc_Name, status );</span>
<a name="l01187"></a>01187 <span class="comment">    return CONTROLLER_OK;</span>
<a name="l01188"></a>01188 <span class="comment">  }</span>
<a name="l01189"></a>01189 <span class="comment">  \endcode</span>
<a name="l01190"></a>01190 <span class="comment">*/</span>
<a name="l01191"></a><a class="code" href="group___o_s_c_a_p_i.html#gbb24f5e4a4c94eef2c321020941c45b3">01191</a> <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#gbb24f5e4a4c94eef2c321020941c45b3" title="Receive data for a subsystem that receives a variety of different data types.">Osc_GeneralReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l01192"></a>01192                            <span class="keywordtype">char</span>* subsystemName, 
<a name="l01193"></a>01193                            <span class="keywordtype">int</span> (*propertySet)( <span class="keywordtype">int</span> property, <span class="keywordtype">char</span>* typedata, <span class="keywordtype">int</span> channel ),
<a name="l01194"></a>01194                            <span class="keywordtype">int</span> (*propertyGet)( <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> channel ),
<a name="l01195"></a>01195                            <span class="keywordtype">char</span>* propertyNames[] )
<a name="l01196"></a>01196 {
<a name="l01197"></a>01197   <span class="keywordflow">if</span> ( message == NULL )
<a name="l01198"></a>01198     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gb3106333ec6e45c789ae5cef04cceba2" title="No OSC property specified.">CONTROLLER_ERROR_NO_PROPERTY</a>;
<a name="l01199"></a>01199 
<a name="l01200"></a>01200   <span class="keywordflow">if</span>( *message == <span class="charliteral">'\0'</span> || *message == <span class="charliteral">' '</span> ) <span class="comment">// first, try to see if it was a property "help" query</span>
<a name="l01201"></a>01201   {
<a name="l01202"></a>01202     <span class="keywordtype">int</span> i = 0;
<a name="l01203"></a>01203     <span class="keywordflow">while</span>( <span class="keyword">true</span> )
<a name="l01204"></a>01204     {
<a name="l01205"></a>01205       <span class="keywordflow">if</span>( propertyNames[i] != 0 )
<a name="l01206"></a>01206       {
<a name="l01207"></a>01207         Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01208"></a>01208         snprintf( Osc-&gt;scratch1, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s"</span>, subsystemName ); 
<a name="l01209"></a>01209         Osc_CreateMessage( channel, Osc-&gt;scratch1, <span class="stringliteral">",s"</span>, propertyNames[i] );
<a name="l01210"></a>01210         Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01211"></a>01211         i++;
<a name="l01212"></a>01212       }
<a name="l01213"></a>01213       <span class="keywordflow">else</span>
<a name="l01214"></a>01214         <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01215"></a>01215     }
<a name="l01216"></a>01216   }
<a name="l01217"></a>01217 
<a name="l01218"></a>01218   <span class="keywordtype">int</span> propertyIndex = Osc_PropertyLookup( propertyNames, message );
<a name="l01219"></a>01219   <span class="keywordflow">if</span> ( propertyIndex == -1 )
<a name="l01220"></a>01220     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g1eef1eb7b55330584d5119c8283b0d0f" title="Property specified is not valid.">CONTROLLER_ERROR_UNKNOWN_PROPERTY</a>;
<a name="l01221"></a>01221 
<a name="l01222"></a>01222 <span class="comment">/*</span>
<a name="l01223"></a>01223 <span class="comment">  int bits;</span>
<a name="l01224"></a>01224 <span class="comment">  int number = Osc_NumberMatch( indexCount, message, &amp;bits );</span>
<a name="l01225"></a>01225 <span class="comment">  if ( number == -1 &amp;&amp; bits == -1 )</span>
<a name="l01226"></a>01226 <span class="comment">    return Osc_SubsystemError( channel, subsystemName, "Bad index" );</span>
<a name="l01227"></a>01227 <span class="comment">*/</span>
<a name="l01228"></a>01228   
<a name="l01229"></a>01229   <span class="comment">// Sometime after the address, the data tag begins - this is the description </span>
<a name="l01230"></a>01230   <span class="comment">// of the data in the rest of the message.  It starts with a comma.  Return</span>
<a name="l01231"></a>01231   <span class="comment">// where it is into 'type'.  If there is no comma, this is bad.</span>
<a name="l01232"></a>01232   <span class="keywordtype">char</span>* type = Osc_FindDataTag( message, length );
<a name="l01233"></a>01233   <span class="keywordflow">if</span> ( type == NULL )
<a name="l01234"></a>01234     <span class="keywordflow">return</span> <a class="code" href="group___o_s_c_a_p_i.html#g852200f3d0612d90d73e9f233392ec2d" title="Send an error back via OSC from your subsystem.">Osc_SubsystemError</a>( channel, subsystemName, <span class="stringliteral">"No type tag"</span> );
<a name="l01235"></a>01235 
<a name="l01236"></a>01236   <span class="comment">// Debug( 1, "Osc General Type[1] = %d", type[ 1 ] );</span>
<a name="l01237"></a>01237 
<a name="l01238"></a>01238   <span class="comment">// We can tell if there's data by seeing if the character after the comma</span>
<a name="l01239"></a>01239   <span class="comment">// is a zero or not.</span>
<a name="l01240"></a>01240   <span class="keywordflow">if</span> ( type[ 1 ] != 0 )
<a name="l01241"></a>01241   {
<a name="l01242"></a>01242     <span class="comment">// If there was data, it was a WRITE.</span>
<a name="l01243"></a>01243     <span class="keywordtype">int</span> status;
<a name="l01244"></a>01244     status = (*propertySet)( propertyIndex, type, channel );
<a name="l01245"></a>01245     <span class="keywordflow">if</span> ( status != <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a> )
<a name="l01246"></a>01246       <span class="keywordflow">return</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>;
<a name="l01247"></a>01247   }
<a name="l01248"></a>01248   <span class="keywordflow">else</span>
<a name="l01249"></a>01249   {
<a name="l01250"></a>01250     <span class="comment">// No data, then.  I guess it was a read.  The XXXXOsc getters</span>
<a name="l01251"></a>01251     <span class="comment">// take the channel number and use it to call</span>
<a name="l01252"></a>01252     <span class="comment">// Osc_CreateMessage() which adds a new message to the outgoing</span>
<a name="l01253"></a>01253     <span class="comment">// stack</span>
<a name="l01254"></a>01254 
<a name="l01255"></a>01255     (*propertyGet)( propertyIndex, channel );
<a name="l01256"></a>01256   }
<a name="l01257"></a>01257 
<a name="l01258"></a>01258   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01259"></a>01259 }
<a name="l01260"></a>01260 <span class="comment"></span>
<a name="l01261"></a>01261 <span class="comment">/** </span>
<a name="l01262"></a>01262 <span class="comment">  Receive integers for a subsystem with multiple indexes.</span>
<a name="l01263"></a>01263 <span class="comment">  An example of this kind of situation is the analog in system - you have 8 channels (indexes) and you're only </span>
<a name="l01264"></a>01264 <span class="comment">  going to be receiving integers.  </span>
<a name="l01265"></a>01265 <span class="comment">  </span>
<a name="l01266"></a>01266 <span class="comment">  You'll usually want to call this when the OSC system calls you with a new message. </span>
<a name="l01267"></a>01267 <span class="comment">  @param channel An index for which OSC channel is being used (usually USB or Ethernet).  Usually provided for you </span>
<a name="l01268"></a>01268 <span class="comment">  by the OSC system.</span>
<a name="l01269"></a>01269 <span class="comment">  @param message The OSC message being received.  Usually provided for you by the OSC system.</span>
<a name="l01270"></a>01270 <span class="comment">  @param length The length of the incoming message.  Usually provided for you by the OSC system.</span>
<a name="l01271"></a>01271 <span class="comment">  @param indexCount The number of indexes in your subsystem.</span>
<a name="l01272"></a>01272 <span class="comment">  @param subsystemName The name of your subsystem.</span>
<a name="l01273"></a>01273 <span class="comment">  @param propertySet A pointer to the function to be called in order to write a property of your subsystem.</span>
<a name="l01274"></a>01274 <span class="comment">  @param propertyGet A pointer to the function to be called in order to read a property of your subsystem.</span>
<a name="l01275"></a>01275 <span class="comment">  @param propertyNames An array of all the property names in your subsystem.</span>
<a name="l01276"></a>01276 <span class="comment">  \ingroup OSCAPI</span>
<a name="l01277"></a>01277 <span class="comment"></span>
<a name="l01278"></a>01278 <span class="comment">  \par Example</span>
<a name="l01279"></a>01279 <span class="comment">  \code</span>
<a name="l01280"></a>01280 <span class="comment">  // this is where OSC calls us when an incoming message for us has arrived</span>
<a name="l01281"></a>01281 <span class="comment">  int MySubsystemOsc_ReceiveMessage( int channel, char* message, int length )</span>
<a name="l01282"></a>01282 <span class="comment">  {</span>
<a name="l01283"></a>01283 <span class="comment">    int status = Osc_GeneralReceiverHelper( channel, message, length,</span>
<a name="l01284"></a>01284 <span class="comment">                                        5, // our index count</span>
<a name="l01285"></a>01285 <span class="comment">                                        MySubsystemOsc_Name,</span>
<a name="l01286"></a>01286 <span class="comment">                                        MySubsystemOsc_PropertySet, MySubsystemOsc_PropertyGet, </span>
<a name="l01287"></a>01287 <span class="comment">                                        MySubsystemOsc_PropertyNames );</span>
<a name="l01288"></a>01288 <span class="comment"></span>
<a name="l01289"></a>01289 <span class="comment">    if ( status != CONTROLLER_OK )</span>
<a name="l01290"></a>01290 <span class="comment">      return Osc_SendError( channel, MySubsystemOsc_Name, status );</span>
<a name="l01291"></a>01291 <span class="comment">    return CONTROLLER_OK;</span>
<a name="l01292"></a>01292 <span class="comment">  }</span>
<a name="l01293"></a>01293 <span class="comment">  \endcode</span>
<a name="l01294"></a>01294 <span class="comment">*/</span>
<a name="l01295"></a><a class="code" href="group___o_s_c_a_p_i.html#gdaa5a3868eeedcf785c3d52f6b36ef34">01295</a> <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#gdaa5a3868eeedcf785c3d52f6b36ef34" title="Receive integers for a subsystem with multiple indexes.">Osc_IndexIntReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l01296"></a>01296                                 <span class="keywordtype">int</span> indexCount, <span class="keywordtype">char</span>* subsystemName, 
<a name="l01297"></a>01297                                 <span class="keywordtype">int</span> (*propertySet)( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> value ),
<a name="l01298"></a>01298                                 <span class="keywordtype">int</span> (*propertyGet)( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property ),
<a name="l01299"></a>01299                                 <span class="keywordtype">char</span>* propertyNames[] )
<a name="l01300"></a>01300 {
<a name="l01301"></a>01301   <span class="keywordtype">int</span> i;
<a name="l01302"></a>01302   <span class="keywordflow">if</span>( *message == <span class="charliteral">'\0'</span> || *message == <span class="charliteral">' '</span> ) <span class="comment">// first, try to see if it was an index "help" query</span>
<a name="l01303"></a>01303   {
<a name="l01304"></a>01304     <span class="keywordflow">for</span> ( i = 0; i &lt; indexCount; i++ )
<a name="l01305"></a>01305     {
<a name="l01306"></a>01306       Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01307"></a>01307       snprintf( Osc-&gt;scratch1, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s"</span>, subsystemName ); 
<a name="l01308"></a>01308       Osc_CreateMessage( channel, Osc-&gt;scratch1, <span class="stringliteral">",i"</span>, i );
<a name="l01309"></a>01309       Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01310"></a>01310     }
<a name="l01311"></a>01311     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01312"></a>01312   }
<a name="l01313"></a>01313   
<a name="l01314"></a>01314   <span class="comment">// Look for the next slash - being the one that separates the index</span>
<a name="l01315"></a>01315   <span class="comment">// from the property.  Note that this won't go off on a search through the buffer</span>
<a name="l01316"></a>01316   <span class="comment">// since there will soon be a string terminator (i.e. a 0)</span>
<a name="l01317"></a>01317   <span class="keywordtype">char</span>* prop = strchr( message, <span class="charliteral">'/'</span> );
<a name="l01318"></a>01318   <span class="keywordtype">char</span>* propHelp = NULL;
<a name="l01319"></a>01319   <span class="keywordflow">if</span> ( prop == NULL )
<a name="l01320"></a>01320     propHelp = message + strlen(message);
<a name="l01321"></a>01321 
<a name="l01322"></a>01322 
<a name="l01323"></a>01323   <span class="comment">// Here's where we try to understand what index we got.  In the world of </span>
<a name="l01324"></a>01324   <span class="comment">// OSC, this could be a pattern.  So while we could get "0/speed" we could </span>
<a name="l01325"></a>01325   <span class="comment">// also get "*/speed" or "[0-4]/speed".  This is kind of a drag, but it is </span>
<a name="l01326"></a>01326   <span class="comment">// quite nice from the user's perspective.</span>
<a name="l01327"></a>01327   <span class="comment">// So to deal with this take a look at the text "0" or "{1,2}" or whatever</span>
<a name="l01328"></a>01328   <span class="comment">// and produce either a nice integer in the simplest case or a set of bits </span>
<a name="l01329"></a>01329   <span class="comment">// where each bit corresponds to one of the indicies.  Clearly we don't have</span>
<a name="l01330"></a>01330   <span class="comment">// to go crazy, since there are only a small finite number of them.</span>
<a name="l01331"></a>01331   <span class="comment">// Osc_NumberMatch() does the work for us, producing either number = -1 and </span>
<a name="l01332"></a>01332   <span class="comment">// bits == -1 if there was no index match, or number != -1 for there was a single</span>
<a name="l01333"></a>01333   <span class="comment">// number, or bits != -1 if there were several.</span>
<a name="l01334"></a>01334 
<a name="l01335"></a>01335   <span class="comment">// note that we tweak the string a bit here to make sure the next '/' is not </span>
<a name="l01336"></a>01336   <span class="comment">// mixed up with this.  Insert a string terminator.</span>
<a name="l01337"></a>01337   *prop = 0;
<a name="l01338"></a>01338 
<a name="l01339"></a>01339   <span class="keywordtype">int</span> bits;
<a name="l01340"></a>01340   <span class="keywordtype">int</span> number = Osc_NumberMatch( indexCount, message, &amp;bits );
<a name="l01341"></a>01341   <span class="keywordflow">if</span> ( number == -1 &amp;&amp; bits == -1 )
<a name="l01342"></a>01342     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>;
<a name="l01343"></a>01343   
<a name="l01344"></a>01344   <span class="comment">// We tweaked the '/' before - now put it back</span>
<a name="l01345"></a>01345   *prop = <span class="charliteral">'/'</span>;
<a name="l01346"></a>01346 
<a name="l01347"></a>01347   <span class="comment">//char* propHelp = prop + 1; // then, see if it was a property "help" query</span>
<a name="l01348"></a>01348   <span class="keywordflow">if</span>( *propHelp == <span class="charliteral">'\0'</span> || *propHelp == <span class="charliteral">' '</span> ) <span class="comment">// first, try to see if it was an index "help" query</span>
<a name="l01349"></a>01349   {
<a name="l01350"></a>01350     i = 0;
<a name="l01351"></a>01351     <span class="keywordflow">while</span>( <span class="keyword">true</span> )
<a name="l01352"></a>01352     {
<a name="l01353"></a>01353       <span class="keywordflow">if</span>( propertyNames[i] != 0 )
<a name="l01354"></a>01354       {
<a name="l01355"></a>01355         Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01356"></a>01356         snprintf( Osc-&gt;scratch1, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s/%d"</span>, subsystemName, number ); 
<a name="l01357"></a>01357         Osc_CreateMessage( channel, Osc-&gt;scratch1, <span class="stringliteral">",s"</span>, propertyNames[i] );
<a name="l01358"></a>01358         Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01359"></a>01359         i++;
<a name="l01360"></a>01360       }
<a name="l01361"></a>01361       <span class="keywordflow">else</span>
<a name="l01362"></a>01362         <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01363"></a>01363     }
<a name="l01364"></a>01364   }
<a name="l01365"></a>01365 
<a name="l01366"></a>01366   <span class="comment">// Now that we know where the property is, we can see if we can find it.</span>
<a name="l01367"></a>01367   <span class="comment">// This is a little cheap, since we're also implying that there are no </span>
<a name="l01368"></a>01368   <span class="comment">// more address terms after the property.  That is, if testing for "speed", while</span>
<a name="l01369"></a>01369   <span class="comment">// "speed" would match, "speed/other_stuff" would not.</span>
<a name="l01370"></a>01370   <span class="keywordtype">int</span> propertyIndex = Osc_PropertyLookup( propertyNames, prop + 1 );
<a name="l01371"></a>01371   <span class="keywordflow">if</span> ( propertyIndex == -1 )
<a name="l01372"></a>01372     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g1eef1eb7b55330584d5119c8283b0d0f" title="Property specified is not valid.">CONTROLLER_ERROR_UNKNOWN_PROPERTY</a>;
<a name="l01373"></a>01373 
<a name="l01374"></a>01374   
<a name="l01375"></a>01375 
<a name="l01376"></a>01376   <span class="comment">// Sometime after the address, the data tag begins - this is the description </span>
<a name="l01377"></a>01377   <span class="comment">// of the data in the rest of the message.  It starts with a comma.  Return</span>
<a name="l01378"></a>01378   <span class="comment">// where it is into 'type'.  If there is no comma, this is bad.</span>
<a name="l01379"></a>01379   <span class="keywordtype">char</span>* type = Osc_FindDataTag( message, length );
<a name="l01380"></a>01380   <span class="keywordflow">if</span> ( type == NULL )
<a name="l01381"></a>01381     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g2a3701fc1ba39056b9926cfab8c622f4" title="Couldn&amp;#39;t find the type tag in this OSC message.">CONTROLLER_ERROR_NO_TYPE_TAG</a>;
<a name="l01382"></a>01382 
<a name="l01383"></a>01383   <span class="comment">// We can tell if there's data by seeing if the character after the comma</span>
<a name="l01384"></a>01384   <span class="comment">// is a zero or not.</span>
<a name="l01385"></a>01385   <span class="keywordflow">if</span> ( type[ 1 ] == <span class="charliteral">'i'</span> || type[ 1 ] == <span class="charliteral">'f'</span> )
<a name="l01386"></a>01386   {
<a name="l01387"></a>01387     <span class="comment">// If there was int or float data, it was a WRITE.</span>
<a name="l01388"></a>01388     <span class="comment">// So, sort of scanff-like, go get the data.  Here we pass in where the data is</span>
<a name="l01389"></a>01389     <span class="comment">// thanks to the previous routine and then specify what we expect to find there</span>
<a name="l01390"></a>01390     <span class="comment">// in tag terms (i.e. "i", "s", "f" and others).  Finally we pass in a set </span>
<a name="l01391"></a>01391     <span class="comment">// of pointers to the data types we want to extract.  Osc_ExtractData()</span>
<a name="l01392"></a>01392     <span class="comment">// will rummage around in the message magically grabbing values for you,</span>
<a name="l01393"></a>01393     <span class="comment">// reporting how many it got.  It will convert ints and floats if necessary.</span>
<a name="l01394"></a>01394     <span class="keywordtype">int</span> value;
<a name="l01395"></a>01395     <span class="keywordtype">int</span> count = Osc_ExtractData( type, <span class="stringliteral">"i"</span>, &amp;value );
<a name="l01396"></a>01396     <span class="keywordflow">if</span> ( count != 1 )
<a name="l01397"></a>01397       <span class="keywordflow">return</span> <a class="code" href="group___error.html#g80c66236574d73ade9c2ef53e5e4200b" title="OSC data type is not valid.">CONTROLLER_ERROR_INCORRECT_DATA_TYPE</a>;
<a name="l01398"></a>01398   
<a name="l01399"></a>01399     <span class="comment">// Now with the data we need to decide what to do with it.</span>
<a name="l01400"></a>01400     <span class="comment">// Is there one or many here?</span>
<a name="l01401"></a>01401     <span class="keywordflow">if</span> ( number != -1 )
<a name="l01402"></a>01402       (*propertySet)( number, propertyIndex, value );
<a name="l01403"></a>01403     <span class="keywordflow">else</span>
<a name="l01404"></a>01404     {
<a name="l01405"></a>01405       <span class="keywordtype">int</span> index = 0;
<a name="l01406"></a>01406       <span class="keywordflow">while</span> ( bits &gt; 0 &amp;&amp; index &lt; indexCount )
<a name="l01407"></a>01407       { 
<a name="l01408"></a>01408         <span class="keywordflow">if</span> ( bits &amp; 1 )
<a name="l01409"></a>01409           (*propertySet)( index, propertyIndex, value );
<a name="l01410"></a>01410         bits &gt;&gt;= 1;
<a name="l01411"></a>01411         index++;
<a name="l01412"></a>01412       }
<a name="l01413"></a>01413     }
<a name="l01414"></a>01414   }
<a name="l01415"></a>01415   <span class="keywordflow">else</span>
<a name="l01416"></a>01416   {
<a name="l01417"></a>01417     <span class="comment">// No data, then.  I guess it was a read.  The XXXXOsc getters</span>
<a name="l01418"></a>01418     <span class="comment">// take the channel number and use it to call</span>
<a name="l01419"></a>01419     <span class="comment">// Osc_CreateMessage() which adds a new message to the outgoing</span>
<a name="l01420"></a>01420     <span class="comment">// stack</span>
<a name="l01421"></a>01421     <span class="keywordflow">if</span> ( number != -1 )
<a name="l01422"></a>01422     { 
<a name="l01423"></a>01423       <span class="keywordtype">int</span> value = (*propertyGet)( number, propertyIndex );
<a name="l01424"></a>01424       Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01425"></a>01425       snprintf( Osc-&gt;scratch1, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s/%d/%s"</span>, subsystemName, number, propertyNames[ propertyIndex ] ); 
<a name="l01426"></a>01426       Osc_CreateMessage( channel, Osc-&gt;scratch1, <span class="stringliteral">",i"</span>, value );
<a name="l01427"></a>01427       Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01428"></a>01428     }
<a name="l01429"></a>01429     <span class="keywordflow">else</span>
<a name="l01430"></a>01430     {
<a name="l01431"></a>01431       <span class="keywordtype">int</span> index = 0;
<a name="l01432"></a>01432       <span class="keywordflow">while</span> ( bits &gt; 0 &amp;&amp; index &lt; indexCount )
<a name="l01433"></a>01433       { 
<a name="l01434"></a>01434         <span class="keywordflow">if</span> ( bits &amp; 1 )
<a name="l01435"></a>01435         {
<a name="l01436"></a>01436           <span class="keywordtype">int</span> value = (*propertyGet)( index, propertyIndex );
<a name="l01437"></a>01437           Osc_LockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01438"></a>01438           snprintf( Osc-&gt;scratch1, OSC_SCRATCH_SIZE, <span class="stringliteral">"/%s/%d/%s"</span>, subsystemName, index, propertyNames[ propertyIndex ] ); 
<a name="l01439"></a>01439           Osc_CreateMessage( channel, Osc-&gt;scratch1, <span class="stringliteral">",i"</span>, value );
<a name="l01440"></a>01440           Osc_UnlockScratchBuf( Osc-&gt;scratch1Semaphore );
<a name="l01441"></a>01441         }
<a name="l01442"></a>01442         bits &gt;&gt;= 1;
<a name="l01443"></a>01443         index++;
<a name="l01444"></a>01444       }
<a name="l01445"></a>01445     }
<a name="l01446"></a>01446   }
<a name="l01447"></a>01447 
<a name="l01448"></a>01448   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01449"></a>01449 }
<a name="l01450"></a>01450 
<a name="l01451"></a>01451 <span class="keywordtype">int</span> Osc_SendError( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* subsystemName, <span class="keywordtype">int</span> error )
<a name="l01452"></a>01452 {
<a name="l01453"></a>01453   <span class="keywordtype">char</span>* errorText;
<a name="l01454"></a>01454   <span class="keywordflow">switch</span> ( error )
<a name="l01455"></a>01455   {
<a name="l01456"></a>01456     <span class="keywordflow">case</span> <a class="code" href="group___error.html#g1eef1eb7b55330584d5119c8283b0d0f" title="Property specified is not valid.">CONTROLLER_ERROR_UNKNOWN_PROPERTY</a>:
<a name="l01457"></a>01457       errorText = <span class="stringliteral">"Unknown Property"</span>;
<a name="l01458"></a>01458       <span class="keywordflow">break</span>;
<a name="l01459"></a>01459     <span class="keywordflow">case</span> <a class="code" href="group___error.html#gb3106333ec6e45c789ae5cef04cceba2" title="No OSC property specified.">CONTROLLER_ERROR_NO_PROPERTY</a>:
<a name="l01460"></a>01460       errorText = <span class="stringliteral">"No Property"</span>;
<a name="l01461"></a>01461       <span class="keywordflow">break</span>;
<a name="l01462"></a>01462     <span class="keywordflow">case</span> <a class="code" href="group___error.html#g80c66236574d73ade9c2ef53e5e4200b" title="OSC data type is not valid.">CONTROLLER_ERROR_INCORRECT_DATA_TYPE</a>:
<a name="l01463"></a>01463       errorText = <span class="stringliteral">"Incorrect Data Type"</span>;
<a name="l01464"></a>01464       <span class="keywordflow">break</span>;
<a name="l01465"></a>01465     <span class="keywordflow">case</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>:
<a name="l01466"></a>01466       errorText = <span class="stringliteral">"Bad Index"</span>;
<a name="l01467"></a>01467       <span class="keywordflow">break</span>;
<a name="l01468"></a>01468     <span class="keywordflow">case</span> <a class="code" href="group___error.html#g63cf0068b15b50e26b6f52c0914f968c" title="Data passed in the wrong format.">CONTROLLER_ERROR_BAD_FORMAT</a>:
<a name="l01469"></a>01469       errorText = <span class="stringliteral">"Bad Format"</span>;
<a name="l01470"></a>01470       <span class="keywordflow">break</span>;
<a name="l01471"></a>01471     <span class="keywordflow">case</span> <a class="code" href="group___error.html#g2a3701fc1ba39056b9926cfab8c622f4" title="Couldn&amp;#39;t find the type tag in this OSC message.">CONTROLLER_ERROR_NO_TYPE_TAG</a>:
<a name="l01472"></a>01472       errorText = <span class="stringliteral">"No Type Tag"</span>;
<a name="l01473"></a>01473       <span class="keywordflow">break</span>;
<a name="l01474"></a>01474     <span class="keywordflow">case</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>:
<a name="l01475"></a>01475       errorText = <span class="stringliteral">"Bad Data"</span>;
<a name="l01476"></a>01476       <span class="keywordflow">break</span>;
<a name="l01477"></a>01477     <span class="keywordflow">default</span>:
<a name="l01478"></a>01478       errorText = <span class="stringliteral">"Error"</span>;
<a name="l01479"></a>01479       <span class="keywordflow">break</span>;
<a name="l01480"></a>01480   }
<a name="l01481"></a>01481   <span class="keywordflow">return</span> <a class="code" href="group___o_s_c_a_p_i.html#g852200f3d0612d90d73e9f233392ec2d" title="Send an error back via OSC from your subsystem.">Osc_SubsystemError</a>( channel, subsystemName, errorText );
<a name="l01482"></a>01482 }
<a name="l01483"></a>01483 
<a name="l01484"></a>01484 <span class="comment">// OSC_ExtractData takes a buffer (i.e. a point in the incoming OSC message)</span>
<a name="l01485"></a>01485 <span class="comment">// And a format e.g. "i" "bb", etc. and unpacks them to the var args</span>
<a name="l01486"></a>01486 <span class="comment">// The var args need to be pointers to memory ready to receive the values.</span>
<a name="l01487"></a>01487 <span class="comment">// In the case of blobs, there need to be three parameters: char** buffer, </span>
<a name="l01488"></a>01488 <span class="comment">// and int* size on the param list.  The buffer gets a pointer into the </span>
<a name="l01489"></a>01489 <span class="comment">// right place in the incoming buffer and the size value gets assigned</span>
<a name="l01490"></a>01490 <span class="keywordtype">int</span> Osc_ExtractData( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">char</span>* format, ... )
<a name="l01491"></a>01491 {
<a name="l01492"></a>01492   <span class="comment">// Set up to iterate through the arguments</span>
<a name="l01493"></a>01493   va_list args;
<a name="l01494"></a>01494   va_start( args, format );
<a name="l01495"></a>01495   <span class="keywordtype">int</span> count = 0;
<a name="l01496"></a>01496 
<a name="l01497"></a>01497   <span class="comment">// figure out where the data starts</span>
<a name="l01498"></a>01498   <span class="keywordtype">int</span> tagLen = strlen( buffer ) + 1;
<a name="l01499"></a>01499   <span class="keywordtype">int</span> pad = tagLen % 4;
<a name="l01500"></a>01500   <span class="keywordflow">if</span> ( pad != 0 )
<a name="l01501"></a>01501     tagLen += ( 4 - pad );
<a name="l01502"></a>01502   <span class="keywordtype">char</span>* data = buffer + tagLen;
<a name="l01503"></a>01503 
<a name="l01504"></a>01504   <span class="comment">// Going to be walking the tag string, the format string and the data</span>
<a name="l01505"></a>01505   <span class="keywordtype">char</span>* fp;
<a name="l01506"></a>01506   <span class="keywordtype">char</span>* tp = buffer + 1; <span class="comment">// need to skip the comma ','</span>
<a name="l01507"></a>01507   <span class="keywordtype">bool</span> cont = <span class="keyword">true</span>;
<a name="l01508"></a>01508   <span class="keywordflow">for</span> ( fp = format; *fp &amp;&amp; cont; fp++ )
<a name="l01509"></a>01509   {
<a name="l01510"></a>01510     cont = <span class="keyword">false</span>;
<a name="l01511"></a>01511     <span class="keywordflow">switch</span> ( *fp )
<a name="l01512"></a>01512     {
<a name="l01513"></a>01513       <span class="keywordflow">case</span> <span class="charliteral">'i'</span>:
<a name="l01514"></a>01514         <span class="keywordflow">if</span> ( *tp == <span class="charliteral">'i'</span> )
<a name="l01515"></a>01515         {
<a name="l01516"></a>01516           *(va_arg( args, <span class="keywordtype">int</span>* )) = Osc_ReadInt( data );
<a name="l01517"></a>01517           data += 4;
<a name="l01518"></a>01518           count++;
<a name="l01519"></a>01519           cont = <span class="keyword">true</span>;
<a name="l01520"></a>01520         }
<a name="l01521"></a>01521         <span class="keywordflow">if</span> ( *tp == <span class="charliteral">'f'</span> )
<a name="l01522"></a>01522         {
<a name="l01523"></a>01523           *(va_arg( args, <span class="keywordtype">int</span>* )) = (<span class="keywordtype">int</span>)Osc_ReadFloat( data );
<a name="l01524"></a>01524           data += 4;
<a name="l01525"></a>01525           count++;
<a name="l01526"></a>01526           cont = <span class="keyword">true</span>;
<a name="l01527"></a>01527         }
<a name="l01528"></a>01528         
<a name="l01529"></a>01529         <span class="keywordflow">break</span>;
<a name="l01530"></a>01530       <span class="keywordflow">case</span> <span class="charliteral">'f'</span>:
<a name="l01531"></a>01531         <span class="keywordflow">if</span> ( *tp == <span class="charliteral">'f'</span> )
<a name="l01532"></a>01532         {
<a name="l01533"></a>01533           *(va_arg( args, <span class="keywordtype">float</span>* )) = Osc_ReadFloat( data );
<a name="l01534"></a>01534           data += 4;
<a name="l01535"></a>01535           count++;
<a name="l01536"></a>01536           cont = <span class="keyword">true</span>;
<a name="l01537"></a>01537         }
<a name="l01538"></a>01538         <span class="keywordflow">if</span> ( *tp == <span class="charliteral">'i'</span> )
<a name="l01539"></a>01539         {
<a name="l01540"></a>01540           *(va_arg( args, <span class="keywordtype">float</span>* )) = (<span class="keywordtype">float</span>)Osc_ReadInt( data );
<a name="l01541"></a>01541           data += 4;
<a name="l01542"></a>01542           count++;
<a name="l01543"></a>01543           cont = <span class="keyword">true</span>;
<a name="l01544"></a>01544         }
<a name="l01545"></a>01545         <span class="keywordflow">break</span>;
<a name="l01546"></a>01546       <span class="keywordflow">case</span> <span class="charliteral">'s'</span>:
<a name="l01547"></a>01547         <span class="keywordflow">if</span> ( *tp == <span class="charliteral">'s'</span> )
<a name="l01548"></a>01548         {
<a name="l01549"></a>01549           *(va_arg( args, <span class="keywordtype">char</span>** )) = data;
<a name="l01550"></a>01550           <span class="keywordtype">int</span> len = strlen( data ) + 1;
<a name="l01551"></a>01551           <span class="keywordtype">int</span> pad = len % 4;
<a name="l01552"></a>01552           <span class="keywordflow">if</span> ( pad != 0 )
<a name="l01553"></a>01553             len += ( 4 - pad );
<a name="l01554"></a>01554           data += len;
<a name="l01555"></a>01555           count++;
<a name="l01556"></a>01556           cont = <span class="keyword">true</span>;
<a name="l01557"></a>01557         }
<a name="l01558"></a>01558         <span class="keywordflow">break</span>;
<a name="l01559"></a>01559       <span class="keywordflow">case</span> <span class="charliteral">'b'</span>:
<a name="l01560"></a>01560         <span class="keywordflow">if</span> ( *tp == <span class="charliteral">'b'</span> )
<a name="l01561"></a>01561         {
<a name="l01562"></a>01562           <span class="keywordtype">int</span> length = Osc_ReadInt( data );
<a name="l01563"></a>01563           data += 4;
<a name="l01564"></a>01564           *(va_arg( args, <span class="keywordtype">char</span>** )) = data;
<a name="l01565"></a>01565           *(va_arg( args, <span class="keywordtype">int</span>* )) = length;
<a name="l01566"></a>01566           <span class="keywordtype">int</span> pad = length % 4;
<a name="l01567"></a>01567           <span class="keywordflow">if</span> ( pad != 0 )
<a name="l01568"></a>01568             length += ( 4 - pad );
<a name="l01569"></a>01569           data += length;
<a name="l01570"></a>01570           count++;
<a name="l01571"></a>01571           cont = <span class="keyword">true</span>;
<a name="l01572"></a>01572         }
<a name="l01573"></a>01573         <span class="keywordflow">else</span>
<a name="l01574"></a>01574         {
<a name="l01575"></a>01575           <span class="keywordflow">if</span> ( *tp == <span class="charliteral">'s'</span> )
<a name="l01576"></a>01576           {
<a name="l01577"></a>01577             *(va_arg( args, <span class="keywordtype">char</span>** )) = data;
<a name="l01578"></a>01578             <span class="keywordtype">int</span> len = strlen( data ) + 1;
<a name="l01579"></a>01579             *(va_arg( args, <span class="keywordtype">int</span>* )) = len;
<a name="l01580"></a>01580             <span class="keywordtype">int</span> pad = len % 4;
<a name="l01581"></a>01581             <span class="keywordflow">if</span> ( pad != 0 )
<a name="l01582"></a>01582               len += ( 4 - pad );
<a name="l01583"></a>01583             data += len;
<a name="l01584"></a>01584             count++;
<a name="l01585"></a>01585             cont = <span class="keyword">true</span>;
<a name="l01586"></a>01586           }
<a name="l01587"></a>01587         }
<a name="l01588"></a>01588         <span class="keywordflow">break</span>;
<a name="l01589"></a>01589     }
<a name="l01590"></a>01590     tp++;
<a name="l01591"></a>01591   }
<a name="l01592"></a>01592 
<a name="l01593"></a>01593   <span class="comment">//va_end( args );</span>
<a name="l01594"></a>01594 
<a name="l01595"></a>01595   <span class="keywordflow">return</span> count;
<a name="l01596"></a>01596 }
<a name="l01597"></a>01597 
<a name="l01598"></a>01598 <span class="keywordtype">int</span> Osc_ReadInt( <span class="keywordtype">char</span>* buffer )
<a name="l01599"></a>01599 {
<a name="l01600"></a>01600   <span class="keywordtype">int</span> v = *((<span class="keywordtype">int</span>*)buffer);
<a name="l01601"></a>01601   v = Osc_EndianSwap( v );
<a name="l01602"></a>01602   <span class="keywordflow">return</span> v;
<a name="l01603"></a>01603 }
<a name="l01604"></a>01604 
<a name="l01605"></a>01605 <span class="keywordtype">float</span> Osc_ReadFloat( <span class="keywordtype">char</span>* buffer )
<a name="l01606"></a>01606 {
<a name="l01607"></a>01607   <span class="keywordtype">int</span> v = *((<span class="keywordtype">int</span>*)buffer);
<a name="l01608"></a>01608   v = Osc_EndianSwap( v );
<a name="l01609"></a>01609   <span class="keywordflow">return</span>  *(<span class="keywordtype">float</span>*)&amp;v;
<a name="l01610"></a>01610 }
<a name="l01611"></a>01611 <span class="comment"></span>
<a name="l01612"></a>01612 <span class="comment">/**</span>
<a name="l01613"></a>01613 <span class="comment">  Osc_CreateMessageNoLock</span>
<a name="l01614"></a>01614 <span class="comment">  Must put the "," as the first format letter</span>
<a name="l01615"></a>01615 <span class="comment">  */</span>
<a name="l01616"></a>01616 <span class="keywordtype">int</span> Osc_CreateMessage( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* address, <span class="keywordtype">char</span>* format, ... )
<a name="l01617"></a>01617 {
<a name="l01618"></a>01618   <span class="keywordflow">if</span> ( address == NULL || format == NULL || *format != <span class="charliteral">','</span> )
<a name="l01619"></a>01619     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>;
<a name="l01620"></a>01620 
<a name="l01621"></a>01621   <span class="keywordflow">if</span> ( channel &lt; 0 || channel &gt;= OSC_CHANNEL_COUNT )
<a name="l01622"></a>01622     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g097f40c958abccd892d08f31b53c4dde" title="The requested index is not valid.">CONTROLLER_ERROR_ILLEGAL_INDEX</a>;
<a name="l01623"></a>01623 
<a name="l01624"></a>01624   OscChannel* ch = Osc-&gt;channel[ channel ];
<a name="l01625"></a>01625 
<a name="l01626"></a>01626   <span class="keywordflow">if</span> ( !ch-&gt;running )
<a name="l01627"></a>01627     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g11e238ec8f200a9a39f8f9ad077c7229" title="Couldn&amp;#39;t complete operation because the subsystem is inactive.">CONTROLLER_ERROR_SUBSYSTEM_INACTIVE</a>;
<a name="l01628"></a>01628 
<a name="l01629"></a>01629   <span class="keywordflow">if</span> ( channel == OSC_CHANNEL_UDP &amp;&amp; ch-&gt;replyAddress == 0 )
<a name="l01630"></a>01630     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gf0c0d854039c8ccbb5fed2a35ded843b" title="Board doesn&amp;#39;t have an address.">CONTROLLER_ERROR_NO_ADDRESS</a>;
<a name="l01631"></a>01631 
<a name="l01632"></a>01632   <span class="comment">// Check for sender</span>
<a name="l01633"></a>01633   <span class="keywordflow">if</span> ( ch-&gt;sendMessage == NULL )
<a name="l01634"></a>01634     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g7495c452431132a3feeefee52ce69135" title="Resource is missing.">CONTROLLER_ERROR_RESOURCE_MISSING</a>;
<a name="l01635"></a>01635 
<a name="l01636"></a>01636   <span class="keywordflow">if</span> ( Osc_Lock( ch ) != <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a> )
<a name="l01637"></a>01637     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g266dd00cf91a01e73619d6e6b2c5ed83" title="An error occurred while trying to lock.">CONTROLLER_ERROR_LOCK_ERROR</a>;
<a name="l01638"></a>01638 
<a name="l01639"></a>01639   <span class="keywordflow">if</span> ( ch-&gt;bufferPointer == NULL )
<a name="l01640"></a>01640     Osc_ResetChannel( ch );
<a name="l01641"></a>01641 
<a name="l01642"></a>01642   <span class="comment">// try to send this message - if there's a problem somewhere, </span>
<a name="l01643"></a>01643   <span class="comment">// send the existing buffer - freeing up space, then try (once) again.</span>
<a name="l01644"></a>01644   <span class="keywordtype">int</span> count = 0;
<a name="l01645"></a>01645   <span class="keywordtype">char</span> *bp;
<a name="l01646"></a>01646   <span class="keywordflow">do</span>
<a name="l01647"></a>01647   {  
<a name="l01648"></a>01648     count++;
<a name="l01649"></a>01649 
<a name="l01650"></a>01650     <span class="keywordtype">char</span>* buffer = ch-&gt;bufferPointer;
<a name="l01651"></a>01651     <span class="keywordtype">int</span> length = ch-&gt;bufferRemaining;
<a name="l01652"></a>01652   
<a name="l01653"></a>01653     bp = buffer;
<a name="l01654"></a>01654   
<a name="l01655"></a>01655     <span class="comment">// First message in the buffer?</span>
<a name="l01656"></a>01656     <span class="keywordflow">if</span> ( bp == ch-&gt;buffer )
<a name="l01657"></a>01657     {
<a name="l01658"></a>01658       bp = Osc_CreateBundle( bp, &amp;length, 0, 0 );
<a name="l01659"></a>01659       <span class="keywordflow">if</span> ( bp == NULL )
<a name="l01660"></a>01660         <span class="keywordflow">return</span> <a class="code" href="group___error.html#g2cd3e8ce9b1d59bb5bf2972ab35a8b48" title="Not enough memory available.">CONTROLLER_ERROR_INSUFFICIENT_RESOURCES</a>;
<a name="l01661"></a>01661     }
<a name="l01662"></a>01662   
<a name="l01663"></a>01663     <span class="comment">// Make room for the new message</span>
<a name="l01664"></a>01664     <span class="keywordtype">int</span>* lp = (<span class="keywordtype">int</span> *)bp;
<a name="l01665"></a>01665     bp += 4;
<a name="l01666"></a>01666     length -= 4;
<a name="l01667"></a>01667 
<a name="l01668"></a>01668     <span class="comment">// remember the start of the message</span>
<a name="l01669"></a>01669     <span class="keywordtype">char</span>* mp = bp;    
<a name="l01670"></a>01670 
<a name="l01671"></a>01671     <span class="keywordflow">if</span> ( length &gt; 0 )
<a name="l01672"></a>01672     {      
<a name="l01673"></a>01673       <span class="comment">// Set up to iterate through the arguments</span>
<a name="l01674"></a>01674       va_list args;
<a name="l01675"></a>01675       va_start( args, format );
<a name="l01676"></a>01676     
<a name="l01677"></a>01677       bp = Osc_CreateMessageInternal( bp, &amp;length, address, format, args ); 
<a name="l01678"></a>01678 
<a name="l01679"></a>01679       <span class="comment">//va_end( args );</span>
<a name="l01680"></a>01680     }
<a name="l01681"></a>01681     <span class="keywordflow">else</span>
<a name="l01682"></a>01682       bp = 0;
<a name="l01683"></a>01683       
<a name="l01684"></a>01684     <span class="keywordflow">if</span> ( bp != 0 )
<a name="l01685"></a>01685     {
<a name="l01686"></a>01686       <span class="comment">// Set the size</span>
<a name="l01687"></a>01687       *lp = Osc_EndianSwap( bp - mp ); 
<a name="l01688"></a>01688   
<a name="l01689"></a>01689       ch-&gt;bufferPointer = bp;
<a name="l01690"></a>01690       ch-&gt;bufferRemaining = length;
<a name="l01691"></a>01691       ch-&gt;messages++;
<a name="l01692"></a>01692     }
<a name="l01693"></a>01693     <span class="keywordflow">else</span>
<a name="l01694"></a>01694     {
<a name="l01695"></a>01695       Osc_SendPacketInternal( ch );
<a name="l01696"></a>01696     }
<a name="l01697"></a>01697   } <span class="keywordflow">while</span> ( bp == 0 &amp;&amp; count == 1 );
<a name="l01698"></a>01698 
<a name="l01699"></a>01699   Osc_Unlock( ch );
<a name="l01700"></a>01700 
<a name="l01701"></a>01701   <span class="keywordflow">return</span> ( bp != 0 ) ? <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a> : <a class="code" href="group___error.html#g7736777a3f60d07d1aa15dc68b563abc" title="Parameter is not valid.">CONTROLLER_ERROR_ILLEGAL_PARAMETER_VALUE</a>;
<a name="l01702"></a>01702 }
<a name="l01703"></a>01703 
<a name="l01704"></a>01704 <span class="keywordtype">int</span> Osc_CreateMessageToBuf( <span class="keywordtype">char</span>* bp, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* address, <span class="keywordtype">char</span>* format, ... )
<a name="l01705"></a>01705 {
<a name="l01706"></a>01706   <span class="keywordflow">if</span> ( address == NULL || format == NULL || *format != <span class="charliteral">','</span> )
<a name="l01707"></a>01707     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gc07582f7dcf5e71e78f3134424ecfc5c" title="Error reading data.">CONTROLLER_ERROR_BAD_DATA</a>;
<a name="l01708"></a>01708 
<a name="l01709"></a>01709   va_list args;
<a name="l01710"></a>01710   va_start( args, format );
<a name="l01711"></a>01711     
<a name="l01712"></a>01712   Osc_CreateMessageInternal( bp, length, address, format, args );
<a name="l01713"></a>01713   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01714"></a>01714 }
<a name="l01715"></a>01715 
<a name="l01716"></a>01716 <span class="keywordtype">char</span>* Osc_CreateMessageInternal( <span class="keywordtype">char</span>* bp, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* address, <span class="keywordtype">char</span>* format, va_list args )
<a name="l01717"></a>01717 {
<a name="l01718"></a>01718   <span class="comment">// do the address</span>
<a name="l01719"></a>01719   bp = Osc_WritePaddedString( bp, length, address );
<a name="l01720"></a>01720   <span class="keywordflow">if</span> ( bp == NULL )
<a name="l01721"></a>01721     <span class="keywordflow">return</span> 0;
<a name="l01722"></a>01722 
<a name="l01723"></a>01723   <span class="comment">// do the type</span>
<a name="l01724"></a>01724   bp = Osc_WritePaddedString( bp, length, format );
<a name="l01725"></a>01725   <span class="keywordflow">if</span> ( bp == NULL )
<a name="l01726"></a>01726     <span class="keywordflow">return</span> 0;
<a name="l01727"></a>01727 
<a name="l01728"></a>01728   <span class="comment">// Going to be walking the tag string, the format string and the data</span>
<a name="l01729"></a>01729   <span class="comment">// skip the ',' comma</span>
<a name="l01730"></a>01730   <span class="keywordtype">char</span>* fp;
<a name="l01731"></a>01731   <span class="keywordtype">bool</span> cont = <span class="keyword">true</span>;
<a name="l01732"></a>01732   <span class="keywordflow">for</span> ( fp = format + 1; *fp &amp;&amp; cont; fp++ )
<a name="l01733"></a>01733   {
<a name="l01734"></a>01734     <span class="keywordflow">switch</span> ( *fp )
<a name="l01735"></a>01735     {
<a name="l01736"></a>01736       <span class="keywordflow">case</span> <span class="charliteral">'i'</span>:
<a name="l01737"></a>01737           *length -= 4;
<a name="l01738"></a>01738           <span class="keywordflow">if</span> ( *length &gt;= 0 )
<a name="l01739"></a>01739           {
<a name="l01740"></a>01740             <span class="keywordtype">int</span> v = va_arg( args, <span class="keywordtype">int</span> );
<a name="l01741"></a>01741             v = Osc_EndianSwap( v );
<a name="l01742"></a>01742             *((<span class="keywordtype">int</span>*)bp) = v;
<a name="l01743"></a>01743             bp += 4;
<a name="l01744"></a>01744           }
<a name="l01745"></a>01745           <span class="keywordflow">else</span> 
<a name="l01746"></a>01746             cont = <span class="keyword">false</span>;
<a name="l01747"></a>01747         <span class="keywordflow">break</span>;
<a name="l01748"></a>01748       <span class="keywordflow">case</span> <span class="charliteral">'f'</span>:
<a name="l01749"></a>01749         *length -= 4;
<a name="l01750"></a>01750         <span class="keywordflow">if</span> ( *length &gt;= 0 )
<a name="l01751"></a>01751         {
<a name="l01752"></a>01752           <span class="keywordtype">int</span> v;
<a name="l01753"></a>01753           *((<span class="keywordtype">float</span>*)&amp;v) = (float)( va_arg( args, <span class="keywordtype">double</span> ) ); 
<a name="l01754"></a>01754           v = Osc_EndianSwap( v );
<a name="l01755"></a>01755           *((<span class="keywordtype">int</span>*)bp) = v;
<a name="l01756"></a>01756           bp += 4;
<a name="l01757"></a>01757         }
<a name="l01758"></a>01758         <span class="keywordflow">else</span> 
<a name="l01759"></a>01759           cont = <span class="keyword">false</span>;
<a name="l01760"></a>01760         <span class="keywordflow">break</span>;
<a name="l01761"></a>01761       <span class="keywordflow">case</span> <span class="charliteral">'s'</span>:
<a name="l01762"></a>01762       {
<a name="l01763"></a>01763         <span class="keywordtype">char</span>* s = va_arg( args, <span class="keywordtype">char</span>* );
<a name="l01764"></a>01764         bp = Osc_WritePaddedString( bp, length, s );
<a name="l01765"></a>01765         <span class="keywordflow">if</span> ( bp == NULL )
<a name="l01766"></a>01766           cont = <span class="keyword">false</span>;
<a name="l01767"></a>01767         <span class="keywordflow">break</span>;
<a name="l01768"></a>01768       }
<a name="l01769"></a>01769       <span class="keywordflow">case</span> <span class="charliteral">'b'</span>:
<a name="l01770"></a>01770       {
<a name="l01771"></a>01771         <span class="keywordtype">char</span>* b = va_arg( args, <span class="keywordtype">char</span>* );
<a name="l01772"></a>01772         <span class="keywordtype">int</span> blen = va_arg( args, <span class="keywordtype">int</span> );
<a name="l01773"></a>01773         bp = Osc_WritePaddedBlob( bp, length, b, blen  );
<a name="l01774"></a>01774         <span class="keywordflow">if</span> ( bp == NULL )
<a name="l01775"></a>01775           cont = <span class="keyword">false</span>;
<a name="l01776"></a>01776         <span class="keywordflow">break</span>;
<a name="l01777"></a>01777       }
<a name="l01778"></a>01778       <span class="keywordflow">default</span>:
<a name="l01779"></a>01779         cont = <span class="keyword">false</span>;
<a name="l01780"></a>01780     }
<a name="l01781"></a>01781   }
<a name="l01782"></a>01782 
<a name="l01783"></a>01783   <span class="keywordflow">return</span> ( cont ) ? bp : NULL;
<a name="l01784"></a>01784 }
<a name="l01785"></a>01785 
<a name="l01786"></a>01786 <span class="keywordtype">char</span>* Osc_CreateBundle( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b )
<a name="l01787"></a>01787 {
<a name="l01788"></a>01788   <span class="keywordtype">char</span> *bp = buffer;
<a name="l01789"></a>01789 
<a name="l01790"></a>01790   <span class="comment">// do the bundle bit</span>
<a name="l01791"></a>01791   bp = Osc_WritePaddedString( bp, length, <span class="stringliteral">"#bundle"</span> );
<a name="l01792"></a>01792   <span class="keywordflow">if</span> ( bp == NULL )
<a name="l01793"></a>01793     <span class="keywordflow">return</span> 0;
<a name="l01794"></a>01794 
<a name="l01795"></a>01795   <span class="comment">// do the timetag</span>
<a name="l01796"></a>01796   bp = Osc_WriteTimetag( bp, length, a, b );
<a name="l01797"></a>01797   <span class="keywordflow">if</span> ( bp == NULL )
<a name="l01798"></a>01798     <span class="keywordflow">return</span> 0;
<a name="l01799"></a>01799 
<a name="l01800"></a>01800   <span class="keywordflow">return</span> bp;
<a name="l01801"></a>01801 }
<a name="l01802"></a>01802 
<a name="l01803"></a>01803 <span class="keywordtype">int</span> Osc_Lock( OscChannel* ch )
<a name="l01804"></a>01804 {
<a name="l01805"></a>01805   <span class="comment">// Check for semphore lock - Critical to avoid multiple creates</span>
<a name="l01806"></a>01806   <a class="code" href="group___tasks.html#gd02e088c48f69fd07cf3157bcceb01b7" title="Specify that a task is entering a period during which it should not be interrupted...">TaskEnterCritical</a>( );
<a name="l01807"></a>01807   <span class="keywordflow">if</span> ( !ch-&gt;semaphore )
<a name="l01808"></a>01808       vSemaphoreCreateBinary( ch-&gt;semaphore );
<a name="l01809"></a>01809   <a class="code" href="group___tasks.html#g0911fd273992ff4dec66d096a9dc3257" title="Specify that a task is exiting a critical period, in response to TaskEnterCritical()...">TaskExitCritical</a>( );
<a name="l01810"></a>01810 
<a name="l01811"></a>01811   <span class="comment">// Lock up this program segment to prevent multiple use</span>
<a name="l01812"></a>01812   <span class="keywordflow">if</span> ( !xSemaphoreTake( ch-&gt;semaphore, 1000 ) )
<a name="l01813"></a>01813     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g266dd00cf91a01e73619d6e6b2c5ed83" title="An error occurred while trying to lock.">CONTROLLER_ERROR_LOCK_ERROR</a>;
<a name="l01814"></a>01814   
<a name="l01815"></a>01815   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01816"></a>01816 }
<a name="l01817"></a>01817 
<a name="l01818"></a>01818 <span class="keywordtype">void</span> Osc_Unlock( OscChannel *ch )
<a name="l01819"></a>01819 {
<a name="l01820"></a>01820   xSemaphoreGive( ch-&gt;semaphore );
<a name="l01821"></a>01821 }
<a name="l01822"></a>01822 
<a name="l01823"></a>01823 <span class="keywordtype">int</span> Osc_LockScratchBuf( xSemaphoreHandle scratchSemaphore )
<a name="l01824"></a>01824 {
<a name="l01825"></a>01825   <span class="comment">// Lock up this program segment to prevent multiple use</span>
<a name="l01826"></a>01826   <span class="keywordflow">if</span> ( !xSemaphoreTake( scratchSemaphore, 1000 ) )
<a name="l01827"></a>01827     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g266dd00cf91a01e73619d6e6b2c5ed83" title="An error occurred while trying to lock.">CONTROLLER_ERROR_LOCK_ERROR</a>;
<a name="l01828"></a>01828 
<a name="l01829"></a>01829   <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01830"></a>01830 }
<a name="l01831"></a>01831 
<a name="l01832"></a>01832 <span class="keywordtype">int</span> Osc_UnlockScratchBuf( xSemaphoreHandle scratchSemaphore )
<a name="l01833"></a>01833 {
<a name="l01834"></a>01834   <span class="keywordflow">if</span>( !xSemaphoreGive( scratchSemaphore ) )
<a name="l01835"></a>01835     <span class="keywordflow">return</span> <a class="code" href="group___error.html#g266dd00cf91a01e73619d6e6b2c5ed83" title="An error occurred while trying to lock.">CONTROLLER_ERROR_LOCK_ERROR</a>;
<a name="l01836"></a>01836   <span class="keywordflow">else</span>
<a name="l01837"></a>01837     <span class="keywordflow">return</span> <a class="code" href="group___error.html#gaa42bc036fbba18487ae9a15cd1f2f94" title="All&amp;#39;s well here.">CONTROLLER_OK</a>;
<a name="l01838"></a>01838 }
<a name="l01839"></a>01839 
<a name="l01840"></a>01840 <span class="keywordtype">int</span> Osc_NumberMatch( <span class="keywordtype">int</span> count, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span>* bits )
<a name="l01841"></a>01841 {
<a name="l01842"></a>01842   <span class="keywordtype">int</span> n = 0;
<a name="l01843"></a>01843   <span class="keywordtype">int</span> digits = 0;
<a name="l01844"></a>01844   <span class="keywordflow">while</span> ( isdigit( *message ) )
<a name="l01845"></a>01845   {
<a name="l01846"></a>01846     digits++;
<a name="l01847"></a>01847     n = n * 10 + ( *message++ - <span class="charliteral">'0'</span> );
<a name="l01848"></a>01848   }
<a name="l01849"></a>01849 
<a name="l01850"></a>01850   *bits = -1;
<a name="l01851"></a>01851   <span class="keywordflow">if</span> ( n &gt;= count )
<a name="l01852"></a>01852     <span class="keywordflow">return</span> -1;
<a name="l01853"></a>01853 
<a name="l01854"></a>01854   <span class="keywordflow">switch</span> ( *message )
<a name="l01855"></a>01855   {
<a name="l01856"></a>01856     <span class="keywordflow">case</span> <span class="charliteral">'*'</span>:
<a name="l01857"></a>01857     <span class="keywordflow">case</span> <span class="charliteral">'?'</span>:
<a name="l01858"></a>01858     <span class="keywordflow">case</span> <span class="charliteral">'['</span>:
<a name="l01859"></a>01859     <span class="keywordflow">case</span> <span class="charliteral">'{'</span>:
<a name="l01860"></a>01860     {
<a name="l01861"></a>01861       <span class="keywordtype">int</span> i;
<a name="l01862"></a>01862       <span class="keywordtype">int</span> b = 0;
<a name="l01863"></a>01863       <span class="keywordtype">char</span> s[ 5 ];
<a name="l01864"></a>01864       <span class="keywordflow">for</span> ( i = count - 1; i &gt;=0 ; i-- )
<a name="l01865"></a>01865       {
<a name="l01866"></a>01866         b &lt;&lt;= 1;
<a name="l01867"></a>01867         sprintf( s, <span class="stringliteral">"%d"</span>, i );
<a name="l01868"></a>01868         <span class="keywordflow">if</span> ( Osc_PatternMatch( message, s ) )
<a name="l01869"></a>01869           b |= 1;
<a name="l01870"></a>01870       }
<a name="l01871"></a>01871       *bits = b;
<a name="l01872"></a>01872       <span class="keywordflow">return</span> -1;
<a name="l01873"></a>01873     }
<a name="l01874"></a>01874     <span class="keywordflow">default</span>:
<a name="l01875"></a>01875       <span class="keywordflow">if</span> ( digits == 0 )
<a name="l01876"></a>01876         <span class="keywordflow">return</span> -1;
<a name="l01877"></a>01877       <span class="keywordflow">return</span> n;
<a name="l01878"></a>01878   }
<a name="l01879"></a>01879 }
<a name="l01880"></a>01880 
<a name="l01881"></a>01881 <span class="comment">// Looks the named property up, returning an index</span>
<a name="l01882"></a>01882 <span class="comment">// Note that we need to be careful - there may be other stuff there in the string</span>
<a name="l01883"></a>01883 <span class="comment">// Probably best to eventually do something better with it.</span>
<a name="l01884"></a>01884 <span class="keywordtype">int</span> Osc_PropertyLookup( <span class="keywordtype">char</span>** properties, <span class="keywordtype">char</span>* property )
<a name="l01885"></a>01885 {
<a name="l01886"></a>01886   <span class="keywordtype">char</span>** p = properties;
<a name="l01887"></a>01887   <span class="keywordtype">int</span> index = 0;
<a name="l01888"></a>01888   <span class="keywordflow">while</span> (*p != NULL )
<a name="l01889"></a>01889   {
<a name="l01890"></a>01890     <span class="keywordflow">if</span> ( strcmp( property, *p++ ) == 0 )
<a name="l01891"></a>01891       <span class="keywordflow">return</span> index;
<a name="l01892"></a>01892     index++;
<a name="l01893"></a>01893   }
<a name="l01894"></a>01894   <span class="keywordflow">return</span> -1;
<a name="l01895"></a>01895 }
<a name="l01896"></a>01896 
<a name="l01897"></a>01897 <span class="keywordtype">char</span> *Osc_FindDataTag( <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length )
<a name="l01898"></a>01898 {
<a name="l01899"></a>01899   <span class="keywordflow">while</span> ( *message != <span class="charliteral">','</span> &amp;&amp; length-- &gt; 0 )
<a name="l01900"></a>01900     message++;
<a name="l01901"></a>01901   <span class="keywordflow">if</span> ( length &lt;= 0 )
<a name="l01902"></a>01902     <span class="keywordflow">return</span> NULL;
<a name="l01903"></a>01903   <span class="keywordflow">else</span>
<a name="l01904"></a>01904     <span class="keywordflow">return</span> message;
<a name="l01905"></a>01905 }
<a name="l01906"></a>01906 
<a name="l01907"></a>01907 <span class="keywordtype">char</span>* Osc_WritePaddedString( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* <span class="keywordtype">string</span> )
<a name="l01908"></a>01908 {
<a name="l01909"></a>01909   <span class="keywordtype">int</span> tagLen = strlen( <span class="keywordtype">string</span> ) + 1;
<a name="l01910"></a>01910   <span class="keywordtype">int</span> tagPadLen = tagLen;
<a name="l01911"></a>01911   <span class="keywordtype">int</span> pad = ( tagPadLen ) % 4;
<a name="l01912"></a>01912   <span class="keywordflow">if</span> ( pad != 0 )
<a name="l01913"></a>01913     tagPadLen += ( 4 - pad );
<a name="l01914"></a>01914  
<a name="l01915"></a>01915   *length -= tagPadLen;
<a name="l01916"></a>01916 
<a name="l01917"></a>01917   <span class="keywordflow">if</span> ( *length &gt;= 0 )
<a name="l01918"></a>01918   {
<a name="l01919"></a>01919     strcpy( buffer, <span class="keywordtype">string</span> );
<a name="l01920"></a>01920     <span class="keywordtype">int</span> i;
<a name="l01921"></a>01921     buffer += tagLen;
<a name="l01922"></a>01922     <span class="keywordflow">for</span> ( i = tagLen; i &lt; tagPadLen; i++ ) 
<a name="l01923"></a>01923       *buffer++ = 0;
<a name="l01924"></a>01924   }
<a name="l01925"></a>01925   <span class="keywordflow">else</span>
<a name="l01926"></a>01926     <span class="keywordflow">return</span> NULL;
<a name="l01927"></a>01927 
<a name="l01928"></a>01928   <span class="keywordflow">return</span> buffer;
<a name="l01929"></a>01929 }
<a name="l01930"></a>01930 
<a name="l01931"></a>01931 <span class="keywordtype">char</span>* Osc_WritePaddedBlob( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* blob, <span class="keywordtype">int</span> blen )
<a name="l01932"></a>01932 {
<a name="l01933"></a>01933   <span class="keywordtype">int</span> i;
<a name="l01934"></a>01934   <span class="keywordtype">int</span> padLength = blen;
<a name="l01935"></a>01935   <span class="keywordtype">int</span> pad = ( padLength ) % 4;
<a name="l01936"></a>01936   <span class="keywordflow">if</span> ( pad != 0 )
<a name="l01937"></a>01937     padLength += ( 4 - pad );
<a name="l01938"></a>01938  
<a name="l01939"></a>01939   <span class="keywordflow">if</span> ( *length &lt; ( padLength + 4 ) )
<a name="l01940"></a>01940     <span class="keywordflow">return</span> 0;
<a name="l01941"></a>01941 
<a name="l01942"></a>01942   <span class="comment">// add the length of the blob</span>
<a name="l01943"></a>01943   <span class="keywordtype">int</span> l = Osc_EndianSwap( blen );
<a name="l01944"></a>01944   *((<span class="keywordtype">int</span>*)buffer) = l;
<a name="l01945"></a>01945   buffer += 4;
<a name="l01946"></a>01946   *length -= 4;
<a name="l01947"></a>01947 
<a name="l01948"></a>01948   memcpy( buffer, blob, blen );
<a name="l01949"></a>01949   buffer += blen;
<a name="l01950"></a>01950   <span class="comment">// reduce the remaining buffer size</span>
<a name="l01951"></a>01951   *length -= padLength;
<a name="l01952"></a>01952 
<a name="l01953"></a>01953   <span class="keywordflow">for</span> ( i = blen; i &lt; padLength; i++ ) 
<a name="l01954"></a>01954       *buffer++ = 0;
<a name="l01955"></a>01955 
<a name="l01956"></a>01956   <span class="keywordflow">return</span> buffer;
<a name="l01957"></a>01957 }
<a name="l01958"></a>01958 
<a name="l01959"></a>01959 <span class="keywordtype">char</span>* Osc_WriteTimetag( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span>* length, <span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b )
<a name="l01960"></a>01960 {
<a name="l01961"></a>01961   <span class="keywordflow">if</span> ( *length &lt; 8 )
<a name="l01962"></a>01962     <span class="keywordflow">return</span> NULL;
<a name="l01963"></a>01963 
<a name="l01964"></a>01964   *((<span class="keywordtype">int</span>*)buffer) = Osc_EndianSwap( a );
<a name="l01965"></a>01965   buffer += 4;
<a name="l01966"></a>01966   *((<span class="keywordtype">int</span>*)buffer) = Osc_EndianSwap( b );
<a name="l01967"></a>01967   buffer += 4;
<a name="l01968"></a>01968   *length -= 8;
<a name="l01969"></a>01969 
<a name="l01970"></a>01970   <span class="keywordflow">return</span> buffer;
<a name="l01971"></a>01971 }
<a name="l01972"></a>01972 
<a name="l01973"></a>01973 <span class="keywordtype">int</span> Osc_EndianSwap( <span class="keywordtype">int</span> a )
<a name="l01974"></a>01974 {
<a name="l01975"></a>01975   <span class="keywordflow">return</span> ( ( a &amp; 0x000000FF ) &lt;&lt; 24 ) |
<a name="l01976"></a>01976          ( ( a &amp; 0x0000FF00 ) &lt;&lt; 8 )  | 
<a name="l01977"></a>01977          ( ( a &amp; 0x00FF0000 ) &gt;&gt; 8 )  | 
<a name="l01978"></a>01978          ( ( a &amp; 0xFF000000 ) &gt;&gt; 24 );
<a name="l01979"></a>01979 
<a name="l01980"></a>01980 }
<a name="l01981"></a>01981 
<a name="l01982"></a>01982 <span class="preprocessor">#endif // OSC</span>
<a name="l01983"></a>01983 <span class="preprocessor"></span>
<a name="l01984"></a>01984 
</pre></div><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit</title>
<style type="text/css">
<!--
.footer {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 9pt;
	color: #999999;
}
-->
</style>
</head>

<body>
<hr size="1">
<div>
  <p class="footer">The Make Controller Kit is an open source project maintained by <a href="http://www.makingthings.com">MakingThings</a>.<br />
    MakingThings code is released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html" target="_blank">Apache 2.0 license</a>.<br />
    Bug tracker, development wiki and status can be found at <a href="http://dev.makingthings.com">http://dev.makingthings.com</a>.<br />
		This document was last updated on 5 Dec 2007.
</p>
</div>
<!-- Google Analytics Code -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-769030-1";
urchinTracker();
</script>
</body>
</html>
